{ "info": { "_postman_id": "b52b5f03-218a-417d-82c3-1c86554cfe1c", "name": "emnify REST API", "description": "The emnify REST API gives programmatic access to the emnify IoT SuperNetwork \u2014 global cellular connectivity for IoT devices. Manage SIMs, endpoints (devices), service and tariff profiles, events, SMS, eSIM (SGP.32) profiles, organizations, users, API callbacks, and the Data Streamer. Authenticate with application tokens or user credentials; tokens are short-lived JWTs.\n\nSource: emnify developer documentation (https://docs.emnify.com/developers/api). This spec is assembled from the per-operation OpenAPI fragments published in the emnify llms-full.txt feed.\n\nContact Support:\n Name: emnify Developer Support", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:08:22.000Z", "updatedAt": "2026-06-05T15:08:24.000Z", "lastUpdatedBy": "35240", "uid": "35240-b52b5f03-218a-417d-82c3-1c86554cfe1c" }, "item": [ { "name": "api", "item": [ { "name": "v1", "item": [ { "name": "api_callback", "item": [ { "name": "{api_callback_id}", "item": [ { "name": "Get a callback URL by ID", "id": "3c062b1d-92ec-4556-ad74-6731153dae08", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/api_callback/:api_callback_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api_callback", ":api_callback_id" ], "variable": [ { "id": "2382c435-a62e-4a3a-b4bb-74824d672953", "key": "api_callback_id", "value": "", "description": "(Required) A numeric ID of an API Callback URL" } ] } }, "response": [ { "id": "260148ac-3a4d-4469-8416-aeb281d2ca3b", "name": "API Callback by ID", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/api_callback/:api_callback_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api_callback", ":api_callback_id" ], "variable": [ { "key": "api_callback_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-260148ac-3a4d-4469-8416-aeb281d2ca3b" }, { "id": "3f2e30f7-0b40-4d20-a01d-82183ccf956e", "name": "API Callback with this ID not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/api_callback/:api_callback_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api_callback", ":api_callback_id" ], "variable": [ { "key": "api_callback_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3f2e30f7-0b40-4d20-a01d-82183ccf956e" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3c062b1d-92ec-4556-ad74-6731153dae08" }, { "name": "Delete a callback URL", "id": "5b07c954-4c36-4474-95db-37d1ca743cb9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/api_callback/:api_callback_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api_callback", ":api_callback_id" ], "variable": [ { "id": "04cbb978-ce64-4a7e-a061-162581e16919", "key": "api_callback_id", "value": "", "description": "(Required) A numeric ID of an API Callback URL" } ] } }, "response": [ { "id": "74ab729a-5bb3-4b57-9ba6-709e068b59a7", "name": "Resource Deleted", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/api_callback/:api_callback_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api_callback", ":api_callback_id" ], "variable": [ { "key": "api_callback_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-74ab729a-5bb3-4b57-9ba6-709e068b59a7" }, { "id": "3c130dc4-6f8f-4607-b946-c621c51bc95e", "name": "API Callback with this ID not found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/api_callback/:api_callback_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api_callback", ":api_callback_id" ], "variable": [ { "key": "api_callback_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3c130dc4-6f8f-4607-b946-c621c51bc95e" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5b07c954-4c36-4474-95db-37d1ca743cb9" } ], "id": "a469c904-cbc6-4563-a1be-dc8b4de9dd51", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a469c904-cbc6-4563-a1be-dc8b4de9dd51" }, { "name": "Retrieve list of API callback URLs", "id": "5ee69632-1e39-4984-9b59-8376edff3e73", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/api_callback", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api_callback" ] } }, "response": [ { "id": "b3988417-0d52-405a-a8b1-5361e5b3253d", "name": "Successfully retrieved a list of API Callback URLs", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/api_callback", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api_callback" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b3988417-0d52-405a-a8b1-5361e5b3253d" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5ee69632-1e39-4984-9b59-8376edff3e73" }, { "name": "Create a callback URL", "id": "2727d25e-6b29-4141-8b93-aeefd30a38df", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"Any type\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/api_callback", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api_callback" ] }, "description": "Create Callback URL" }, "response": [ { "id": "4d32c63c-4087-468b-b8cf-893802cd6c95", "name": "Resource Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"Any type\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/api_callback", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api_callback" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-4d32c63c-4087-468b-b8cf-893802cd6c95" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2727d25e-6b29-4141-8b93-aeefd30a38df" } ], "id": "a31acf28-1bac-41d2-99c8-8830024a840e", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a31acf28-1bac-41d2-99c8-8830024a840e" }, { "name": "api_secret", "item": [ { "name": "{api_secret_id}", "item": [ { "name": "Get a callback secret by ID", "id": "92c660d6-295d-4424-806a-af2e94abe3c7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/api_secret/:api_secret_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api_secret", ":api_secret_id" ], "variable": [ { "id": "66125f1d-0bdf-476e-aa58-02cddff7a1bf", "key": "api_secret_id", "value": "", "description": "(Required) A numeric ID of an API secret" } ] } }, "response": [ { "id": "607edffd-1577-4e9d-b1d8-42165467ed12", "name": "API Secret by ID", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/api_secret/:api_secret_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api_secret", ":api_secret_id" ], "variable": [ { "key": "api_secret_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"organisation_id\": \"\",\n \"purpose\": \"\",\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-607edffd-1577-4e9d-b1d8-42165467ed12" }, { "id": "2b09a001-ddf2-46e6-bee0-14503a83843f", "name": "API Callback with this ID not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/api_secret/:api_secret_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api_secret", ":api_secret_id" ], "variable": [ { "key": "api_secret_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2b09a001-ddf2-46e6-bee0-14503a83843f" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-92c660d6-295d-4424-806a-af2e94abe3c7" }, { "name": "Delete a callback secret", "id": "6ac403d5-5c08-456e-8dc4-70d0b76558b7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/api_secret/:api_secret_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api_secret", ":api_secret_id" ], "variable": [ { "id": "a0d00b59-dad3-4f80-a2da-8c32787b4997", "key": "api_secret_id", "value": "", "description": "(Required) A numeric ID of an API Secret" } ] } }, "response": [ { "id": "597dfd58-2865-4031-abbd-ae9085cc5cab", "name": "Resource Deleted", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/api_secret/:api_secret_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api_secret", ":api_secret_id" ], "variable": [ { "key": "api_secret_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-597dfd58-2865-4031-abbd-ae9085cc5cab" }, { "id": "c07c9ebe-1179-45fb-a82b-f953ce67f853", "name": "Secret with this ID not found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/api_secret/:api_secret_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api_secret", ":api_secret_id" ], "variable": [ { "key": "api_secret_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c07c9ebe-1179-45fb-a82b-f953ce67f853" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6ac403d5-5c08-456e-8dc4-70d0b76558b7" } ], "id": "94594729-8beb-4882-9fcb-5e86bb2b8c50", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-94594729-8beb-4882-9fcb-5e86bb2b8c50" }, { "name": "List API callback secrets", "id": "9fcd81d6-1a78-456e-a8df-883d253e1a10", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/api_secret", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api_secret" ] }, "description": "Lists API callback secrets.\n\n\n The `secret` property itself is not returned in this call.\n\n" }, "response": [ { "id": "1adf98b1-9941-4708-a0d8-1c7cca72359a", "name": "Successfully retrieved a list of API Callback Secrets", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/api_secret", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api_secret" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"organisation_id\": \"\",\n \"purpose\": \"\",\n \"id\": \"\"\n },\n {\n \"organisation_id\": \"\",\n \"purpose\": \"\",\n \"id\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1adf98b1-9941-4708-a0d8-1c7cca72359a" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9fcd81d6-1a78-456e-a8df-883d253e1a10" }, { "name": "Create a callback secret", "id": "7f66517e-4e04-4922-a682-1492459a2ed4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"organisation_id\": \"\",\n \"purpose\": \"\",\n \"id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/api_secret", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api_secret" ] }, "description": "Creates a new secret that may be used by API callbacks.\n\nWhen an `api_secret` is assigned to a Service Profile with an API callback, API requests towards this URL will contain an `Authorization` header with a JSON Web Token.\nThe `api_secret` is used as the **Signing Key** of the JWT.\n" }, "response": [ { "id": "14b2fa58-c98e-4564-92ee-ae3513f94e5a", "name": "Resource Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"organisation_id\": \"\",\n \"purpose\": \"\",\n \"id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/api_secret", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "api_secret" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-14b2fa58-c98e-4564-92ee-ae3513f94e5a" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7f66517e-4e04-4922-a682-1492459a2ed4" } ], "id": "75b399d1-24eb-46a1-9a16-3bf8f399ecf4", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-75b399d1-24eb-46a1-9a16-3bf8f399ecf4" }, { "name": "application_token", "item": [ { "name": "{app_token_id}", "item": [ { "name": "Update application token", "id": "94af1983-dd85-4c3d-b432-6d7ecd349439", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"status\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/application_token/:app_token_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "application_token", ":app_token_id" ], "variable": [ { "id": "7bea586a-ed2a-4765-8f23-b595b8c1a524", "key": "app_token_id", "value": "", "description": "(Required) application token ID" } ] }, "description": "The `description` of the token may be updated and the\nApplication Token can be revoked by updating the `status`.\nThe possible statuses of tokens are\n\n* `\"id\": 0` - Activated\n* `\"id\": 1` - Revoked\n" }, "response": [ { "id": "3bd429f1-27bc-40a9-bf9f-2880fc41d89b", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"status\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/application_token/:app_token_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "application_token", ":app_token_id" ], "variable": [ { "key": "app_token_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3bd429f1-27bc-40a9-bf9f-2880fc41d89b" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-94af1983-dd85-4c3d-b432-6d7ecd349439" } ], "id": "a5defd91-5848-4db4-8a03-9d69556792fa", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a5defd91-5848-4db4-8a03-9d69556792fa" }, { "name": "List application tokens", "id": "ee8db74b-afbe-4fbd-b9dc-c1e869d9717c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/application_token", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "application_token" ] }, "description": "Returns the list of application tokens for the organisation of the requesting user." }, "response": [ { "id": "636dd4cc-1e07-448d-8314-b625bbd8a2a0", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/application_token", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "application_token" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"status\": {},\n \"expiry_date\": \"\",\n \"ip\": \"\",\n \"creator\": {}\n },\n {\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"status\": {},\n \"expiry_date\": \"\",\n \"ip\": \"\",\n \"creator\": {}\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-636dd4cc-1e07-448d-8314-b625bbd8a2a0" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ee8db74b-afbe-4fbd-b9dc-c1e869d9717c" }, { "name": "Create application token", "id": "4864ab33-5c9a-487a-8204-9def60559e7d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"expiry_date\": \"\",\n \"ip\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/application_token", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "application_token" ] }, "description": "Creates a new application token.\nID must not be specified, as it is auto-generated and returned in case of a successful JSON response.\nYou can provide following fields with this request:\n\n* `description` (String, optional)\n* `expiry_date` with optional time + time zone (String, optional)\n* `ip` - IP Address in CIDR notation (String, optional)\n" }, "response": [ { "id": "dda76318-efc0-4519-9782-8ba32a8703ce", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"expiry_date\": \"\",\n \"ip\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/application_token", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "application_token" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"application_token\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-dda76318-efc0-4519-9782-8ba32a8703ce" }, { "id": "d5cb2797-95df-48b5-80f4-b759bdf0e4b2", "name": "Unprocessable Entity. See HTTP response body for details.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"expiry_date\": \"\",\n \"ip\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/application_token", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "application_token" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d5cb2797-95df-48b5-80f4-b759bdf0e4b2" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-4864ab33-5c9a-487a-8204-9def60559e7d" } ], "id": "42a7f720-2254-4b1e-b154-fa6847c6c175", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-42a7f720-2254-4b1e-b154-fa6847c6c175" }, { "name": "authenticate", "item": [ { "name": "workspace", "item": [ { "name": "Switch to an assigned Workspace", "id": "846eefed-5f43-4ecd-bf93-8b7a67d19112", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"target_organisation\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/authenticate/workspace", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "authenticate", "workspace" ] }, "description": "Switch to an assigned Workspace and receive an authentication token for the target Workspace.\n\n\n This endpoint requires authentication with [user credentials](/developers/auth/user-credentials) (not an application token), as application tokens are scoped to a single Workspace.\n\n The returned `auth_token` is valid for the target Workspace.\n Your original token remains valid for the source Workspace.\n\n" }, "response": [ { "id": "c2ef180f-331b-4057-842e-e2f0ad237312", "name": "Successfully switched to the assigned Workspace", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"target_organisation\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/authenticate/workspace", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "authenticate", "workspace" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"auth_token\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c2ef180f-331b-4057-842e-e2f0ad237312" }, { "id": "663e9efd-fb0b-4571-a3c1-5977568181eb", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"target_organisation\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/authenticate/workspace", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "authenticate", "workspace" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-663e9efd-fb0b-4571-a3c1-5977568181eb" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-846eefed-5f43-4ecd-bf93-8b7a67d19112" } ], "id": "e0334735-26cb-42f1-8fe5-6a2eb3d9fbbc", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e0334735-26cb-42f1-8fe5-6a2eb3d9fbbc" }, { "name": "Retrieve authentication token", "id": "9288974f-b61b-4e68-ae8f-af36faf70006", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"application_token\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"fingerprint\": \"\",\n \"refresh_token\": \"\",\n \"mfa_token\": \"\",\n \"code\": \"\",\n \"trusted_device\": {\n \"fingerprint\": \"\",\n \"operating_system\": \"\",\n \"browser\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/authenticate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "authenticate" ] }, "description": "Returns a [JSON Web Token (JWT)](/developers/auth/jwts) `auth_token` for authenticating further requests to the API.\n\n\n This API path has a rate limit of 100 requests per IP in a 5-minute window.\n Make sure to store your authentication token to avoid hitting this limit.\n For more information, see [Rate limits](/developers/api-guidelines/rate-limits).\n\n\n### Multi-factor authentication flow\n\nWhen multi-factor authentication (MFA) is enabled for a user account:\n\n1. **Initial login**: Send your username and SHA-1 hashed password.\n If MFA is enabled and the device isn't trusted, you receive an `mfa_token` instead of `auth_token` in the response and a one-time password (OTP) via email.\n2. **MFA verification**: Send the `mfa_token` with the 6-digit OTP `code`.\n Optionally include `trusted_device` information to skip MFA for 90 days.\n3. **Subsequent logins**: If you included a trusted device fingerprint during verification, send your username and SHA-1 hashed password with the `fingerprint` to bypass MFA.\n\nFor more information, see [Multi-factor authentication](/developers/auth/multi-factor-authentication).\n" }, "response": [ { "id": "8e6e93f5-1167-43ae-9e60-b63ba5d1f60b", "name": "Successful Authentication Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"application_token\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"fingerprint\": \"\",\n \"refresh_token\": \"\",\n \"mfa_token\": \"\",\n \"code\": \"\",\n \"trusted_device\": {\n \"fingerprint\": \"\",\n \"operating_system\": \"\",\n \"browser\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/authenticate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "authenticate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"auth_token\": \"\",\n \"refresh_token\": \"\",\n \"mfa_token\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8e6e93f5-1167-43ae-9e60-b63ba5d1f60b" }, { "id": "1eb1a496-0882-4413-bb97-3d5c64fea47d", "name": "The request body is malformed or fails validation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"application_token\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"fingerprint\": \"\",\n \"refresh_token\": \"\",\n \"mfa_token\": \"\",\n \"code\": \"\",\n \"trusted_device\": {\n \"fingerprint\": \"\",\n \"operating_system\": \"\",\n \"browser\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/authenticate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "authenticate" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1eb1a496-0882-4413-bb97-3d5c64fea47d" }, { "id": "6adf076b-66ef-4cc9-856b-e832404c2ddc", "name": "The response body is empty for most authentication failures (invalid credentials, suspended or deleted user, etc.).\nWhen account lockout is triggered after three consecutive failed authentication attempts, the response body contains the `TooManyRequests` ", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"application_token\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"fingerprint\": \"\",\n \"refresh_token\": \"\",\n \"mfa_token\": \"\",\n \"code\": \"\",\n \"trusted_device\": {\n \"fingerprint\": \"\",\n \"operating_system\": \"\",\n \"browser\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/authenticate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "authenticate" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6adf076b-66ef-4cc9-856b-e832404c2ddc" }, { "id": "434e97b2-02a9-4f73-a672-cf6fa1e5b3b3", "name": "Unexpected error in API call.\nSee HTTP response body for details.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"application_token\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"fingerprint\": \"\",\n \"refresh_token\": \"\",\n \"mfa_token\": \"\",\n \"code\": \"\",\n \"trusted_device\": {\n \"fingerprint\": \"\",\n \"operating_system\": \"\",\n \"browser\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/authenticate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "authenticate" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-434e97b2-02a9-4f73-a672-cf6fa1e5b3b3" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9288974f-b61b-4e68-ae8f-af36faf70006" } ], "id": "00b514fa-62d0-4d99-920f-4240218ca831", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-00b514fa-62d0-4d99-920f-4240218ca831" }, { "name": "automation", "item": [ { "name": "action", "item": [ { "name": "{id}", "item": [ { "name": "Get an action by ID", "id": "8178e4fb-284e-40fe-90f5-43aed8b1ff49", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/automation/action/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automation", "action", ":id" ], "variable": [ { "id": "3814f971-c2a9-455f-898e-d39b49459a45", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Retrieves a specified available actions, as well as the possible configuration parameters and required fields.\nAvailability depends on the parent organization.\n" }, "response": [ { "id": "f11a3767-633f-4d17-84b7-665c75312ede", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/automation/action/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automation", "action", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"configurationProperties\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"translationKeyName\": \"\",\n \"description\": \"\",\n \"translationKeyDescription\": \"\",\n \"requiredEventOutputParameters\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f11a3767-633f-4d17-84b7-665c75312ede" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8178e4fb-284e-40fe-90f5-43aed8b1ff49" } ], "id": "f7d528e6-c354-4ee8-a23e-eae158b712ef", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f7d528e6-c354-4ee8-a23e-eae158b712ef" }, { "name": "List available actions", "id": "2c79d38a-fcb6-4738-83eb-3e68f0a09e90", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/automation/action", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automation", "action" ] }, "description": "Returns a list of all available actions, as well as their possible configuration parameters and required fields.\nAvailability depends on the parent organization.\n" }, "response": [ { "id": "78e2f00d-7f1b-4b48-8513-232d63f86467", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/automation/action", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automation", "action" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"configurationProperties\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"translationKeyName\": \"\",\n \"description\": \"\",\n \"translationKeyDescription\": \"\",\n \"requiredEventOutputParameters\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"configurationProperties\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"translationKeyName\": \"\",\n \"description\": \"\",\n \"translationKeyDescription\": \"\",\n \"requiredEventOutputParameters\": [\n \"\",\n \"\"\n ]\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-78e2f00d-7f1b-4b48-8513-232d63f86467" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2c79d38a-fcb6-4738-83eb-3e68f0a09e90" } ], "id": "68115135-c873-46d0-8485-fb3e2c5b1ea1", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-68115135-c873-46d0-8485-fb3e2c5b1ea1" }, { "name": "log", "item": [ { "name": "List action logs", "id": "244a915a-9697-4f42-b72e-4b9b39b9c5a6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/automation/log?automationId=&automationExecutionNumber=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automation", "log" ], "query": [ { "description": "(Required) ", "key": "automationId", "value": "" }, { "description": "(Required) ", "key": "automationExecutionNumber", "value": "" } ] }, "description": "Returns a list of all action logs for this organization.\n" }, "response": [ { "id": "b783d790-56bf-49ac-8720-f90b4350b653", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/automation/log?automationId=&automationExecutionNumber=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automation", "log" ], "query": [ { "description": "(Required) ", "key": "automationId", "value": "" }, { "description": "(Required) ", "key": "automationExecutionNumber", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"automation\": {\n \"id\": \"\"\n },\n \"action\": {\n \"id\": \"\"\n },\n \"message\": \"\",\n \"status\": \"\",\n \"event\": {\n \"id\": \"\"\n },\n \"smart_event\": {\n \"id\": \"\"\n },\n \"created_at\": \"\",\n \"automation_execution_number\": \"\",\n \"organisation\": {\n \"id\": \"\"\n },\n \"id\": \"\"\n },\n {\n \"automation\": {\n \"id\": \"\"\n },\n \"action\": {\n \"id\": \"\"\n },\n \"message\": \"\",\n \"status\": \"\",\n \"event\": {\n \"id\": \"\"\n },\n \"smart_event\": {\n \"id\": \"\"\n },\n \"created_at\": \"\",\n \"automation_execution_number\": \"\",\n \"organisation\": {\n \"id\": \"\"\n },\n \"id\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b783d790-56bf-49ac-8720-f90b4350b653" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-244a915a-9697-4f42-b72e-4b9b39b9c5a6" } ], "id": "055fc649-2ab6-4608-b72e-2c0a88f8f9bb", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-055fc649-2ab6-4608-b72e-2c0a88f8f9bb" }, { "name": "recipient", "item": [ { "name": "email", "item": [ { "name": "verification", "item": [ { "name": "Verify an automation recipient's email address", "id": "3add21d8-14e6-4aa7-9df6-75ad75440b45", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/automation/recipient/email/verification", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automation", "recipient", "email", "verification" ] }, "description": "Verifies the email address of an automation recipient using the verification token sent to the recipient via email.\n" }, "response": [ { "id": "54b5705f-02b9-4894-971c-d4ece6c2b8fd", "name": "Email verification successful", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/automation/recipient/email/verification", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automation", "recipient", "email", "verification" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-54b5705f-02b9-4894-971c-d4ece6c2b8fd" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3add21d8-14e6-4aa7-9df6-75ad75440b45" } ], "id": "fbac67db-090b-458a-a0d3-b7f527eba3cc", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-fbac67db-090b-458a-a0d3-b7f527eba3cc" } ], "id": "54aaf8e1-e8a2-4569-925b-3d2c4bccde5d", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-54aaf8e1-e8a2-4569-925b-3d2c4bccde5d" } ], "id": "46ef3571-6b24-42ea-b3aa-9f49293115c6", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-46ef3571-6b24-42ea-b3aa-9f49293115c6" }, { "name": "{id}", "item": [ { "name": "Get configured automation by ID", "id": "5e971753-b4f5-4870-8aba-b39378349b62", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/automation/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automation", ":id" ], "variable": [ { "id": "46be136f-16f3-4ed7-a6ad-3ce9dfe37079", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Retrieves the specified configured automation.\n" }, "response": [ { "id": "5bd80d37-2a9f-4f8e-a4cb-787e2bf6447e", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/automation/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automation", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"\",\n \"organisation\": {\n \"id\": \"\"\n },\n \"number_of_executions\": \"\",\n \"last_execution\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"actionable_event\": {\n \"custom_event\": {\n \"organisation\": {\n \"id\": \"\"\n },\n \"template\": {\n \"id\": \"\"\n },\n \"configuration_properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"name\": \"\",\n \"id\": \"\",\n \"supportedTargetingParameters\": [\n \"\",\n \"\"\n ],\n \"supportedActions\": [\n \"\",\n \"\"\n ]\n },\n \"system_event\": {\n \"id\": \"\",\n \"parentOrg\": {\n \"id\": \"\"\n },\n \"eventType\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"translationKeyName\": \"\",\n \"description\": \"\",\n \"translationKeyDescription\": \"\",\n \"supportedTargetingParameters\": [\n \"\",\n \"\"\n ],\n \"eventOutputParameters\": [\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"supportedActions\": [\n \"\",\n \"\"\n ]\n }\n },\n \"configured_actions\": [\n {\n \"action\": {\n \"id\": \"\"\n },\n \"properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"recipients\": {\n \"email\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"action\": {\n \"id\": \"\"\n },\n \"properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"recipients\": {\n \"email\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"targeting_properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5bd80d37-2a9f-4f8e-a4cb-787e2bf6447e" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5e971753-b4f5-4870-8aba-b39378349b62" }, { "name": "Delete a configured automation", "id": "0b15e95e-86a2-4879-aa62-4d082e07753e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/automation/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automation", ":id" ], "variable": [ { "id": "e3f57126-b94d-4962-b44d-b66d5fd8a4d6", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Deletes the specified configured automation.\n" }, "response": [ { "id": "32ef9c30-0b61-4696-8820-d5f5f1474a78", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/automation/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automation", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-32ef9c30-0b61-4696-8820-d5f5f1474a78" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0b15e95e-86a2-4879-aa62-4d082e07753e" }, { "name": "Update an automation", "id": "6394368e-b4f5-4ffe-b7f2-2046d00a753d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"\",\n \"configured_actions\": [\n {\n \"action\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"action\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ],\n \"targeting_properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/automation/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automation", ":id" ], "variable": [ { "id": "47c64694-40a5-4171-b3bc-b2b5543ac453", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Updates an automation with the configured event and selected actions, respecting the configured targets.\n" }, "response": [ { "id": "54851481-23be-44b0-b1d7-fb12964022fa", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"\",\n \"configured_actions\": [\n {\n \"action\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"action\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ],\n \"targeting_properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/automation/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automation", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"\",\n \"organisation\": {\n \"id\": \"\"\n },\n \"number_of_executions\": \"\",\n \"last_execution\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"actionable_event\": {\n \"custom_event\": {\n \"organisation\": {\n \"id\": \"\"\n },\n \"template\": {\n \"id\": \"\"\n },\n \"configuration_properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"name\": \"\",\n \"id\": \"\",\n \"supportedTargetingParameters\": [\n \"\",\n \"\"\n ],\n \"supportedActions\": [\n \"\",\n \"\"\n ]\n },\n \"system_event\": {\n \"id\": \"\",\n \"parentOrg\": {\n \"id\": \"\"\n },\n \"eventType\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"translationKeyName\": \"\",\n \"description\": \"\",\n \"translationKeyDescription\": \"\",\n \"supportedTargetingParameters\": [\n \"\",\n \"\"\n ],\n \"eventOutputParameters\": [\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"supportedActions\": [\n \"\",\n \"\"\n ]\n }\n },\n \"configured_actions\": [\n {\n \"action\": {\n \"id\": \"\"\n },\n \"properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"recipients\": {\n \"email\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"action\": {\n \"id\": \"\"\n },\n \"properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"recipients\": {\n \"email\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"targeting_properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-54851481-23be-44b0-b1d7-fb12964022fa" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6394368e-b4f5-4ffe-b7f2-2046d00a753d" } ], "id": "26f431df-4bcd-4bea-8971-d3a5a9dc062c", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-26f431df-4bcd-4bea-8971-d3a5a9dc062c" }, { "name": "List configured automations", "id": "540e2d38-fd0c-4e84-8153-f409a92ea995", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/automation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automation" ] }, "description": "Returns a list of all configured automations for the organization.\n" }, "response": [ { "id": "fc7d5c9e-1fe0-4b28-a431-b960025ae445", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/automation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automation" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"\",\n \"organisation\": {\n \"id\": \"\"\n },\n \"number_of_executions\": \"\",\n \"last_execution\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"actionable_event\": {\n \"custom_event\": {\n \"organisation\": {\n \"id\": \"\"\n },\n \"template\": {\n \"id\": \"\"\n },\n \"configuration_properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"name\": \"\",\n \"id\": \"\",\n \"supportedTargetingParameters\": [\n \"\",\n \"\"\n ],\n \"supportedActions\": [\n \"\",\n \"\"\n ]\n },\n \"system_event\": {\n \"id\": \"\",\n \"parentOrg\": {\n \"id\": \"\"\n },\n \"eventType\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"translationKeyName\": \"\",\n \"description\": \"\",\n \"translationKeyDescription\": \"\",\n \"supportedTargetingParameters\": [\n \"\",\n \"\"\n ],\n \"eventOutputParameters\": [\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"supportedActions\": [\n \"\",\n \"\"\n ]\n }\n },\n \"configured_actions\": [\n {\n \"action\": {\n \"id\": \"\"\n },\n \"properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"recipients\": {\n \"email\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"action\": {\n \"id\": \"\"\n },\n \"properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"recipients\": {\n \"email\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"targeting_properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"\",\n \"organisation\": {\n \"id\": \"\"\n },\n \"number_of_executions\": \"\",\n \"last_execution\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"actionable_event\": {\n \"custom_event\": {\n \"organisation\": {\n \"id\": \"\"\n },\n \"template\": {\n \"id\": \"\"\n },\n \"configuration_properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"name\": \"\",\n \"id\": \"\",\n \"supportedTargetingParameters\": [\n \"\",\n \"\"\n ],\n \"supportedActions\": [\n \"\",\n \"\"\n ]\n },\n \"system_event\": {\n \"id\": \"\",\n \"parentOrg\": {\n \"id\": \"\"\n },\n \"eventType\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"translationKeyName\": \"\",\n \"description\": \"\",\n \"translationKeyDescription\": \"\",\n \"supportedTargetingParameters\": [\n \"\",\n \"\"\n ],\n \"eventOutputParameters\": [\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"supportedActions\": [\n \"\",\n \"\"\n ]\n }\n },\n \"configured_actions\": [\n {\n \"action\": {\n \"id\": \"\"\n },\n \"properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"recipients\": {\n \"email\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"action\": {\n \"id\": \"\"\n },\n \"properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"recipients\": {\n \"email\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"targeting_properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-fc7d5c9e-1fe0-4b28-a431-b960025ae445" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-540e2d38-fd0c-4e84-8153-f409a92ea995" }, { "name": "Create an automation", "id": "4c973b18-bd71-4b6d-b9fd-028cfebe1447", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"\",\n \"actionable_event\": {\n \"custom_event\": {\n \"id\": \"\"\n },\n \"system_event\": {\n \"id\": \"\"\n }\n },\n \"configured_actions\": [\n {\n \"action\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"action\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ],\n \"targeting_properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/automation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automation" ] }, "description": "Creates an automation with the configured event and selected actions, respecting the configured targets.\n" }, "response": [ { "id": "50a7b688-32d0-4558-9ae9-042e12fb33c2", "name": "response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"\",\n \"actionable_event\": {\n \"custom_event\": {\n \"id\": \"\"\n },\n \"system_event\": {\n \"id\": \"\"\n }\n },\n \"configured_actions\": [\n {\n \"action\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"action\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ],\n \"targeting_properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/automation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "automation" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"\",\n \"organisation\": {\n \"id\": \"\"\n },\n \"number_of_executions\": \"\",\n \"last_execution\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"actionable_event\": {\n \"custom_event\": {\n \"organisation\": {\n \"id\": \"\"\n },\n \"template\": {\n \"id\": \"\"\n },\n \"configuration_properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"name\": \"\",\n \"id\": \"\",\n \"supportedTargetingParameters\": [\n \"\",\n \"\"\n ],\n \"supportedActions\": [\n \"\",\n \"\"\n ]\n },\n \"system_event\": {\n \"id\": \"\",\n \"parentOrg\": {\n \"id\": \"\"\n },\n \"eventType\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"translationKeyName\": \"\",\n \"description\": \"\",\n \"translationKeyDescription\": \"\",\n \"supportedTargetingParameters\": [\n \"\",\n \"\"\n ],\n \"eventOutputParameters\": [\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"supportedActions\": [\n \"\",\n \"\"\n ]\n }\n },\n \"configured_actions\": [\n {\n \"action\": {\n \"id\": \"\"\n },\n \"properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"recipients\": {\n \"email\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"action\": {\n \"id\": \"\"\n },\n \"properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"recipients\": {\n \"email\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"targeting_properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-50a7b688-32d0-4558-9ae9-042e12fb33c2" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-4c973b18-bd71-4b6d-b9fd-028cfebe1447" } ], "id": "139017be-c71a-49ac-851a-759e2bb060fd", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-139017be-c71a-49ac-851a-759e2bb060fd" }, { "name": "breakout_region", "item": [ { "name": "List breakout regions", "id": "21a38aee-cec9-4562-b7b7-5292cc4c8d2a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/breakout_region", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "breakout_region" ] }, "description": "Provides the list of available breakout regions." }, "response": [ { "id": "34d94401-e3cd-476b-972b-40b82f272637", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/breakout_region", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "breakout_region" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"ip_address\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"ip_address\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-34d94401-e3cd-476b-972b-40b82f272637" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-21a38aee-cec9-4562-b7b7-5292cc4c8d2a" } ], "id": "cf7af31b-8f41-4396-9def-25481f160bda", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cf7af31b-8f41-4396-9def-25481f160bda" }, { "name": "cnc", "item": [ { "name": "breakout", "item": [ { "name": "tgw", "item": [ { "name": "Create a Cloud Connect attachment via Transit Gateway", "id": "922eb265-38f2-4a95-b8f2-0ed1650f5e4d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"1\",\n \"name\": \"\",\n \"vpc_cidr\": [\n \"\",\n \"\"\n ],\n \"region\": \"\",\n \"aws_account_id\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout/tgw", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout", "tgw" ] }, "description": "Creates a Transit Gateway breakout towards the customer AWS account.\n\nAfter the creation the following steps have to be made from the customer's AWS account:\n\n1. Accept the resource share about the 'CloudConnect' TransitGateway\n2. Create a Transit Gateway Attachment to the own VPC with the services to connect to\n\nMore Information about this can be found on the Cloud Connect Knowledge Base article.\n" }, "response": [ { "id": "e1a41550-b5fb-4fbc-85bb-76a580c8179b", "name": "Response to a POST that results in a creation, usually will return a Location header pointing to the location of the new resource", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"1\",\n \"name\": \"\",\n \"vpc_cidr\": [\n \"\",\n \"\"\n ],\n \"region\": \"\",\n \"aws_account_id\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout/tgw", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout", "tgw" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e1a41550-b5fb-4fbc-85bb-76a580c8179b" }, { "id": "707360bd-879f-429c-8a44-b85a992c969e", "name": "The request is malformed, e.g. the body cannot be parsed", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"1\",\n \"name\": \"\",\n \"vpc_cidr\": [\n \"\",\n \"\"\n ],\n \"region\": \"\",\n \"aws_account_id\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout/tgw", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout", "tgw" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-707360bd-879f-429c-8a44-b85a992c969e" }, { "id": "7c40f958-d234-425b-bc4b-ff75add00ed1", "name": "Authentication token is valid, but user has no access permissions to the request resource", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"1\",\n \"name\": \"\",\n \"vpc_cidr\": [\n \"\",\n \"\"\n ],\n \"region\": \"\",\n \"aws_account_id\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout/tgw", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout", "tgw" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7c40f958-d234-425b-bc4b-ff75add00ed1" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-922eb265-38f2-4a95-b8f2-0ed1650f5e4d" } ], "id": "1fcdb92b-316c-4e52-b2b5-456a69878db1", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1fcdb92b-316c-4e52-b2b5-456a69878db1" }, { "name": "vpn", "item": [ { "name": "Create a Cloud Connect attachment via IPSec VPN", "id": "08e57e2b-d6cc-411b-9826-9a755dfa251d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": {\n \"id\": \"2\"\n },\n \"name\": \"\",\n \"public_ip\": \"\",\n \"on_prem_cidr\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"region\": \"\",\n \"psk\": \"\",\n \"asn\": \"\",\n \"inside_cidr\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout/vpn", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout", "vpn" ] }, "description": "Creates a Cloud Connect attachment via a specified VPN server.\nCurrently two attachment types are available:\n\n- **Static VPN** (type `2`): Basic IPSec VPN connection\n- **Dynamic VPN with BGP** (type `3`): IPSec VPN with BGP routing.\n Requires `asn` (Autonomous System Number), otherwise dynamic routing is disabled.\n Optionally accepts `inside_cidr` for BGP tunnel interfaces.\n\nThe `on_prem_cidr` parameter specifies the CIDR ranges of your backend network (up to 3).\nThe `public_ip` is the public IP address of your VPN server.\n\nA `psk` (Pre-Shared Key) can be configured with 8-64 alphanumeric characters, periods (`.`), and underscores (`_`).\nIt must not begin with `0`.\nIf left empty, it generates automatically and can be retrieved via [`GET /api/v1/cnc/breakout/{cloudconnect_attachment_id}`](/developers/api/cloud-connect/get-cloud-connect-attachment-by-id).\n\n\n The created connection is available within 3-5 minutes.\n\n" }, "response": [ { "id": "9f2a5e74-f326-4fda-b4a9-2f4ce2bc17f8", "name": "Attachment created successfully.\nThe `Location` header contains the URL of the new resource.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": {\n \"id\": \"2\"\n },\n \"name\": \"\",\n \"public_ip\": \"\",\n \"on_prem_cidr\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"region\": \"\",\n \"psk\": \"\",\n \"asn\": \"\",\n \"inside_cidr\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout/vpn", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout", "vpn" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9f2a5e74-f326-4fda-b4a9-2f4ce2bc17f8" }, { "id": "dcc05fb5-654a-41d9-bc9e-76789410f46d", "name": "The request body is malformed or missing required fields.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": {\n \"id\": \"2\"\n },\n \"name\": \"\",\n \"public_ip\": \"\",\n \"on_prem_cidr\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"region\": \"\",\n \"psk\": \"\",\n \"asn\": \"\",\n \"inside_cidr\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout/vpn", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout", "vpn" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-dcc05fb5-654a-41d9-bc9e-76789410f46d" }, { "id": "b68231d2-5a9d-479f-bfd1-be0a340ba1ca", "name": "Your authentication token is valid, but you don't have permission to access the requested resource.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": {\n \"id\": \"2\"\n },\n \"name\": \"\",\n \"public_ip\": \"\",\n \"on_prem_cidr\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"region\": \"\",\n \"psk\": \"\",\n \"asn\": \"\",\n \"inside_cidr\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout/vpn", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout", "vpn" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b68231d2-5a9d-479f-bfd1-be0a340ba1ca" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-08e57e2b-d6cc-411b-9826-9a755dfa251d" } ], "id": "464d2ebe-6b76-43ae-89d2-3a444aec0c7b", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-464d2ebe-6b76-43ae-89d2-3a444aec0c7b" }, { "name": "{cloudconnect_attachment_id}", "item": [ { "name": "View details of a Cloud Connect attachment", "id": "061e8755-a6ca-404b-bd7e-91cedc047619", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout/:cloudconnect_attachment_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout", ":cloudconnect_attachment_id" ], "variable": [ { "id": "64e5869a-e885-455b-8a23-aa9bcb5a92a4", "key": "cloudconnect_attachment_id", "value": "", "description": "(Required) " } ] }, "description": "Displays the details including configured CIDR blocks of a Cloud Connect Attachment.\n\nFor active IPSec VPN attachments, the tunnel information (public IP, outisde address, inside CIDR, PSK, ASN)\nincluding metrics over the last hour (tunnel state, bytes in/out) will be displayed as well.\n" }, "response": [ { "id": "11eb3961-a9ed-4a6d-bfc6-13d77292c9d6", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout/:cloudconnect_attachment_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout", ":cloudconnect_attachment_id" ], "variable": [ { "key": "cloudconnect_attachment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"user_id\": \"\",\n \"creation_date\": \"\",\n \"accept_attachment_expiry_date\": \"\",\n \"termination_date\": \"\",\n \"aws_transit_gateway_attachment_id\": \"\",\n \"aws_vpn_connection_id\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"type\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"region\": \"\",\n \"tunnel_information\": {\n \"outside_address\": \"\",\n \"inside_cidr\": \"\",\n \"metrics\": {\n \"tunnel_state\": \"\",\n \"bytes_in\": {\n \"sed3c\": \"\"\n },\n \"bytes_out\": {\n \"aute3_\": \"\"\n }\n },\n \"asn\": \"\",\n \"public_ip\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"user_id\": \"\",\n \"creation_date\": \"\",\n \"accept_attachment_expiry_date\": \"\",\n \"termination_date\": \"\",\n \"aws_transit_gateway_attachment_id\": \"\",\n \"aws_vpn_connection_id\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"type\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"region\": \"\",\n \"tunnel_information\": {\n \"outside_address\": \"\",\n \"inside_cidr\": \"\",\n \"metrics\": {\n \"tunnel_state\": \"\",\n \"bytes_in\": {\n \"proident__\": \"\",\n \"ipsum7e\": \"\"\n },\n \"bytes_out\": {\n \"sit_763\": \"\"\n }\n },\n \"asn\": \"\",\n \"public_ip\": \"\"\n }\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-11eb3961-a9ed-4a6d-bfc6-13d77292c9d6" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-061e8755-a6ca-404b-bd7e-91cedc047619" }, { "name": "Delete a specific Cloud Connect attachment", "id": "2b7fb4b8-3aff-4444-9b73-135bfeee119c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout/:cloudconnect_attachment_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout", ":cloudconnect_attachment_id" ], "variable": [ { "id": "dab44286-e05d-4245-9a87-ef0acdb2eca8", "key": "cloudconnect_attachment_id", "value": "", "description": "(Required) " } ] }, "description": "Deletes the specified Cloud Connect attachment.\n\nAttachments cannot be deleted if they are in the state `7 (Deactivated)` or `8 (Rolling Back)` or if they are Classic attachments.\n" }, "response": [ { "id": "6461a6ba-bd99-4997-9d0d-b1436744411b", "name": "Response to a successful GET, also used for a POST if it does not result in a creation", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout/:cloudconnect_attachment_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout", ":cloudconnect_attachment_id" ], "variable": [ { "key": "cloudconnect_attachment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6461a6ba-bd99-4997-9d0d-b1436744411b" }, { "id": "fe1f1983-0188-4b7e-a368-a1047feec95d", "name": "The request is malformed, e.g. the body cannot be parsed", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout/:cloudconnect_attachment_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout", ":cloudconnect_attachment_id" ], "variable": [ { "key": "cloudconnect_attachment_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-fe1f1983-0188-4b7e-a368-a1047feec95d" }, { "id": "483858e1-4ba4-4227-8e30-9b0469ca144f", "name": "Authentication token is valid, but user has no access permissions to the request resource", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout/:cloudconnect_attachment_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout", ":cloudconnect_attachment_id" ], "variable": [ { "key": "cloudconnect_attachment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-483858e1-4ba4-4227-8e30-9b0469ca144f" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2b7fb4b8-3aff-4444-9b73-135bfeee119c" }, { "name": "Retry creation of an expired TGW breakout", "id": "92a8b3f3-d3ff-4b65-a7c0-d27b60f54b3b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout/:cloudconnect_attachment_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout", ":cloudconnect_attachment_id" ], "variable": [ { "id": "7313ada7-abc7-49f6-b3db-c2eef0a96da8", "key": "cloudconnect_attachment_id", "value": "", "description": "(Required) " } ] }, "description": "Retries the creation of a Transit Gateway breakout where the accept attachment state has expired, meaning the\nattachment on the customer's side has not been created in time.\n\nRetry is only allowed if:\n- The breakout is of type `Transit Gateway (type_id: 1)`\n- The breakout is in status `Pending AWS Activation (status_id: 2)`\n- The accept attachment state has expired (7 days after creation)\n" }, "response": [ { "id": "340f46f9-ab20-4015-8302-c4703abef9e7", "name": "Response to a successful GET, also used for a POST if it does not result in a creation", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout/:cloudconnect_attachment_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout", ":cloudconnect_attachment_id" ], "variable": [ { "key": "cloudconnect_attachment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-340f46f9-ab20-4015-8302-c4703abef9e7" }, { "id": "cf1422ea-9da3-44a7-b1f0-5a164f40b2c2", "name": "A non-existent resource is requested", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout/:cloudconnect_attachment_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout", ":cloudconnect_attachment_id" ], "variable": [ { "key": "cloudconnect_attachment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cf1422ea-9da3-44a7-b1f0-5a164f40b2c2" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-92a8b3f3-d3ff-4b65-a7c0-d27b60f54b3b" } ], "id": "2771404e-cacb-4824-963a-e4c9d30cd4f5", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2771404e-cacb-4824-963a-e4c9d30cd4f5" }, { "name": "List all Cloud Connect attachments of an organization", "id": "1e3cc92c-c9bf-4fbc-ae9f-0a4adc12c543", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout?status=6&type=6&organisation=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout" ], "query": [ { "description": "Numerical ID of the Cloud Connect attachment status\n\n* `1` - Pending Customer Action\n* `2` - Pending AWS Activation\n* `3` - Pending EGN Activation\n* `4` - Pending CRG Activation\n* `5` - Active\n* `6` - Deactivation Pending\n* `7` - Deactivated\n* `8` - Rolling Back\n", "key": "status", "value": "6" }, { "description": "Numerical ID of the Cloud Connect attachment type\n\n* `1` - Transit Gateway\n* `2` - IPSec VPN\n* `3` - IPSec VPN BGP\n* `4` - IPSec VPN BGP High Availability\n* `5` - Direct Connect\n* `6` - Shared\n* `7` - Transit Gateway (Classic)\n* `8` - IPSec VPN (Classic)\n", "key": "type", "value": "6" }, { "description": "Numerical ID of an Organization", "key": "organisation", "value": "" } ] }, "description": "Lists all Cloud Connect attachments of the logged in organisation if it is an Enterprise. For Master organisations\nit lists all attachments of the direct child organisations. Deleted attachments are left out by default.\n\nAdditionally the attachments can be filtered by status and type.\nMaster organisations can also filter by organisation ID of their direct child organisations.\n" }, "response": [ { "id": "2f174359-75fd-4bc7-a922-5b4cf8016255", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout?status=6&type=6&organisation=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout" ], "query": [ { "description": "Numerical ID of the Cloud Connect attachment status\n\n* `1` - Pending Customer Action\n* `2` - Pending AWS Activation\n* `3` - Pending EGN Activation\n* `4` - Pending CRG Activation\n* `5` - Active\n* `6` - Deactivation Pending\n* `7` - Deactivated\n* `8` - Rolling Back\n", "key": "status", "value": "6" }, { "description": "Numerical ID of the Cloud Connect attachment type\n\n* `1` - Transit Gateway\n* `2` - IPSec VPN\n* `3` - IPSec VPN BGP\n* `4` - IPSec VPN BGP High Availability\n* `5` - Direct Connect\n* `6` - Shared\n* `7` - Transit Gateway (Classic)\n* `8` - IPSec VPN (Classic)\n", "key": "type", "value": "6" }, { "description": "Numerical ID of an Organization", "key": "organisation", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"user_id\": \"\",\n \"creation_date\": \"\",\n \"accept_attachment_expiry_date\": \"\",\n \"termination_date\": \"\",\n \"aws_transit_gateway_attachment_id\": \"\",\n \"aws_vpn_connection_id\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"type\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"region\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"user_id\": \"\",\n \"creation_date\": \"\",\n \"accept_attachment_expiry_date\": \"\",\n \"termination_date\": \"\",\n \"aws_transit_gateway_attachment_id\": \"\",\n \"aws_vpn_connection_id\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"type\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"region\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2f174359-75fd-4bc7-a922-5b4cf8016255" }, { "id": "abb218c3-1532-44c8-850c-b71bf452f3cc", "name": "Authentication token is valid, but user has no access permissions to the request resource", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout?status=6&type=6&organisation=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout" ], "query": [ { "description": "Numerical ID of the Cloud Connect attachment status\n\n* `1` - Pending Customer Action\n* `2` - Pending AWS Activation\n* `3` - Pending EGN Activation\n* `4` - Pending CRG Activation\n* `5` - Active\n* `6` - Deactivation Pending\n* `7` - Deactivated\n* `8` - Rolling Back\n", "key": "status", "value": "6" }, { "description": "Numerical ID of the Cloud Connect attachment type\n\n* `1` - Transit Gateway\n* `2` - IPSec VPN\n* `3` - IPSec VPN BGP\n* `4` - IPSec VPN BGP High Availability\n* `5` - Direct Connect\n* `6` - Shared\n* `7` - Transit Gateway (Classic)\n* `8` - IPSec VPN (Classic)\n", "key": "type", "value": "6" }, { "description": "Numerical ID of an Organization", "key": "organisation", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-abb218c3-1532-44c8-850c-b71bf452f3cc" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1e3cc92c-c9bf-4fbc-ae9f-0a4adc12c543" } ], "id": "9e7212ef-0e0c-43e5-af5a-9a3a3deed7f3", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9e7212ef-0e0c-43e5-af5a-9a3a3deed7f3" }, { "name": "breakout_type", "item": [ { "name": "{breakout_type_id}", "item": [ { "name": "available_region", "item": [ { "name": "Get list of available Cloud Connect regions by breakout type", "id": "9e473b7c-90fc-46c0-a70c-bf4415e1f3cc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout_type/:breakout_type_id/available_region", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout_type", ":breakout_type_id", "available_region" ], "variable": [ { "id": "009a4ed2-debb-4729-876c-0adcad113173", "key": "breakout_type_id", "value": "", "description": "(Required) ID of a Cloud Connect breakout type. Possible values can be retrieved with `GET /api/v1/cnc/breakout_type`.\n" } ] }, "description": "Returns a list of regions available for use when creating new Cloud Connect breakouts of the selected breakout type.\n\nIf the attachment region is peered to another one, the device breakout region will also be returned.\n" }, "response": [ { "id": "62691247-e4c8-49e7-a49b-5e0a19143610", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout_type/:breakout_type_id/available_region", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout_type", ":breakout_type_id", "available_region" ], "variable": [ { "key": "breakout_type_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"attachment_region\": \"\",\n \"device_breakout_region\": \"\"\n },\n {\n \"attachment_region\": \"\",\n \"device_breakout_region\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-62691247-e4c8-49e7-a49b-5e0a19143610" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9e473b7c-90fc-46c0-a70c-bf4415e1f3cc" } ], "id": "bb5a81c8-9ec4-4a5c-947a-9e3a43fec07e", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-bb5a81c8-9ec4-4a5c-947a-9e3a43fec07e" } ], "id": "b1a2c42d-c306-4f35-a89b-77d8059057d5", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b1a2c42d-c306-4f35-a89b-77d8059057d5" }, { "name": "List Cloud Connect breakout types", "id": "3695f139-74c1-47df-8a4a-277c8d71dc0a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout_type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout_type" ] }, "description": "Lists all Cloud Connect breakout types.\n" }, "response": [ { "id": "73e2ca3e-7efb-4d3a-ba26-1e07e98e7ec0", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/cnc/breakout_type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "breakout_type" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-73e2ca3e-7efb-4d3a-ba26-1e07e98e7ec0" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3695f139-74c1-47df-8a4a-277c8d71dc0a" } ], "id": "f614b579-1230-4d53-b1ec-dabbd1021655", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f614b579-1230-4d53-b1ec-dabbd1021655" }, { "name": "pricing", "item": [ { "name": "List Cloud Connect prices", "id": "0ea7e648-b3bc-4b13-bbc1-f7532fba4fbd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/cnc/pricing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "pricing" ] }, "description": "Returns a list of the configured monthly prices for Cloud Connect breakouts.\n\nMaster organisation, Mobile Network Operators and Resellers will get the list of prices they have configured\nfor their child organisations.\n\nEnterprise organisations will get the list of prices that apply for them.\n" }, "response": [ { "id": "5137e4b7-2708-49bc-b164-fa82255386df", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/cnc/pricing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "cnc", "pricing" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"breakout_type_id\": \"\",\n \"amount\": \"\",\n \"currency\": {\n \"id\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"breakout_type_id\": \"\",\n \"amount\": \"\",\n \"currency\": {\n \"id\": \"\"\n }\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5137e4b7-2708-49bc-b164-fa82255386df" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0ea7e648-b3bc-4b13-bbc1-f7532fba4fbd" } ], "id": "3928aa80-34d1-44f1-9e0b-aafc6a6858e2", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3928aa80-34d1-44f1-9e0b-aafc6a6858e2" } ], "id": "f16558c0-1cb2-4c66-a1e7-52676c8cada9", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f16558c0-1cb2-4c66-a1e7-52676c8cada9" }, { "name": "country", "item": [ { "name": "List country codes", "id": "0d2d3c88-aa60-4663-ae9d-e32998dab88a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/country?geographic=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "country" ], "query": [ { "description": "Filters the country list for geographic countries only.\nThis will exclude duplicate countries with different MCCs, like `India MCC 405` or `United States (311)`.\n", "key": "geographic", "value": "" } ] }, "description": "Provides the list of available countries (lookup)." }, "response": [ { "id": "fd5ea382-0740-4827-8a01-f2ca8df3fc02", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/country?geographic=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "country" ], "query": [ { "description": "Filters the country list for geographic countries only.\nThis will exclude duplicate countries with different MCCs, like `India MCC 405` or `United States (311)`.\n", "key": "geographic", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"mcc\": \"\",\n \"iso_code\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"mcc\": \"\",\n \"iso_code\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-fd5ea382-0740-4827-8a01-f2ca8df3fc02" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0d2d3c88-aa60-4663-ae9d-e32998dab88a" } ], "id": "15126ede-3ab2-4bb4-9adb-b02002ab621a", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-15126ede-3ab2-4bb4-9adb-b02002ab621a" }, { "name": "currency", "item": [ { "name": "List currencies", "id": "aa6834f7-24ce-4818-8724-3918e458d85f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/currency", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "currency" ] }, "description": "Provides the list of available currencies (lookup)." }, "response": [ { "id": "0138d0cf-108d-46b1-9404-591f95a0be24", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/currency", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "currency" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"code\": \"\",\n \"symbol\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"symbol\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0138d0cf-108d-46b1-9404-591f95a0be24" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-aa6834f7-24ce-4818-8724-3918e458d85f" } ], "id": "9b00eb17-928c-4149-b972-b91c758440ad", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9b00eb17-928c-4149-b972-b91c758440ad" }, { "name": "data_blocksize", "item": [ { "name": "List data blocksizes", "id": "4ec30c92-3ee6-443b-b7cb-cfc4f1cd2b69", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/data_blocksize", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "data_blocksize" ] }, "description": "Provides the list of available data blocksizes (lookup)." }, "response": [ { "id": "75668eed-ab41-4b25-9d74-a2a0a2af8f34", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/data_blocksize", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "data_blocksize" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"octets\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"octets\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-75668eed-ab41-4b25-9d74-a2a0a2af8f34" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-4ec30c92-3ee6-443b-b7cb-cfc4f1cd2b69" } ], "id": "50c91723-7c66-4712-991d-82e0c77ff2ad", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-50c91723-7c66-4712-991d-82e0c77ff2ad" }, { "name": "data_throttle", "item": [ { "name": "List data throttles", "id": "7d84593f-7488-46da-8bbf-ff3139afcbd7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/data_throttle", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "data_throttle" ] }, "description": "Provides the list of available data throttles (lookup)." }, "response": [ { "id": "6af52049-8aea-4726-b7db-e697168f28d5", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/data_throttle", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "data_throttle" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"octets\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"octets\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6af52049-8aea-4726-b7db-e697168f28d5" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7d84593f-7488-46da-8bbf-ff3139afcbd7" } ], "id": "5a8db87a-fc0c-47f7-a691-f6e4760be91c", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5a8db87a-fc0c-47f7-a691-f6e4760be91c" }, { "name": "dns", "item": [ { "name": "{dns_id}", "item": [ { "name": "Delete DNS config", "id": "6c2c40c2-6beb-4761-a22f-85b20260682e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/dns/:dns_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "dns", ":dns_id" ], "variable": [ { "id": "01ca3326-3510-4e89-b8fc-60317b0dccbf", "key": "dns_id", "value": "", "description": "(Required) DNS configuration ID" } ] }, "description": "Delete a DNS configuration object by ID.\n\n\n A DNS config object cannot be deleted if it is in use by at least one Service Profile.\n\n" }, "response": [ { "id": "a17a3a97-355b-49d1-a9de-14c8f98d0aa2", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/dns/:dns_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "dns", ":dns_id" ], "variable": [ { "key": "dns_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a17a3a97-355b-49d1-a9de-14c8f98d0aa2" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6c2c40c2-6beb-4761-a22f-85b20260682e" } ], "id": "55bd4700-20f5-4555-a27e-afb279e81d92", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-55bd4700-20f5-4555-a27e-afb279e81d92" }, { "name": "List DNS configs", "id": "8f17c47b-9f23-4ba0-9558-a7b1ada59147", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/dns", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "dns" ] }, "description": "Retrieves a list of DNS configurations.\nDNS settings can be applied to a service profile and endpoints which use this service profile will have the associated DNS settings applied.\n" }, "response": [ { "id": "3901f2fa-6676-4baa-b05a-d01fe2fc7a1d", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/dns", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "dns" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"primary\": \"\",\n \"secondary\": \"\",\n \"ip_address_version\": \"\"\n },\n {\n \"id\": \"\",\n \"primary\": \"\",\n \"secondary\": \"\",\n \"ip_address_version\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3901f2fa-6676-4baa-b05a-d01fe2fc7a1d" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8f17c47b-9f23-4ba0-9558-a7b1ada59147" }, { "name": "Create DNS config", "id": "6f5e8c45-a5fb-491a-bc1c-769793af1559", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"primary\": \"\",\n \"secondary\": \"\",\n \"ip_address_version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/dns", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "dns" ] }, "description": "Creates a DNS configuration object. The DNS config can be applied to a service profile and all endpoints which use that service profile will have the associated DNS settings applied.\nDNS changes are instantly applied to any **new PDP context**.\nConnected devices with previously established PDPs will continue to use the previous nameserver config until the next time they reconnect.\n\nPrimary and secondary nameservers and IP version (`4` for IPV4 or `6` for IPV6) must be specified with this request.\n\n\n The system currently falls back to IPV4 for the actually-enforced networking settings of endpoints, therefore **the IPV6 parameter will be ignored** when provided.\n\n" }, "response": [ { "id": "432bf1de-5426-40b9-a957-b8c200328443", "name": "Resource Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"primary\": \"\",\n \"secondary\": \"\",\n \"ip_address_version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/dns", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "dns" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-432bf1de-5426-40b9-a957-b8c200328443" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6f5e8c45-a5fb-491a-bc1c-769793af1559" } ], "id": "b6f866cb-2c6e-4393-9ef7-643dad6a6bde", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b6f866cb-2c6e-4393-9ef7-643dad6a6bde" }, { "name": "endpoint", "item": [ { "name": "status", "item": [ { "name": "List endpoint statuses", "id": "ca3faf25-69ef-4850-8a90-74515a5d3f31", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", "status" ] }, "description": "Returns a list of available [endpoint statuses](/developers/reference/endpoint#endpoint-statuses)." }, "response": [ { "id": "a46fb1fc-426a-4f67-b791-eddb2693a1e1", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a46fb1fc-426a-4f67-b791-eddb2693a1e1" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ca3faf25-69ef-4850-8a90-74515a5d3f31" } ], "id": "7b703a27-4584-4871-b97a-8df932f73662", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7b703a27-4584-4871-b97a-8df932f73662" }, { "name": "{endpoint_id}", "item": [ { "name": "connectivity", "item": [ { "name": "Endpoint connectivity status", "id": "1dee1e6e-646b-4be7-9398-96fc506eaec6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/connectivity", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "connectivity" ], "variable": [ { "id": "976a9793-09a5-4117-a528-688d5fd09936", "key": "endpoint_id", "value": "", "description": "(Required) " } ] }, "description": "Retrieve details about current connectivity status of endpoint.\nThe following is a list of possible statuses:\n\n* `ATTACHED`:\nThe Endpoint has succesfully attached to the Home Core network in the past.\nThe device will be shown as `ATTACHED` until the visited network has signaled that the device is inactive/offline.\nUsually the visited network informs the Core Network within 1-2 days after a device went offline.\n\n* `ONLINE`:\nThe Endpoint has an active data connection\n\n* `OFFLINE`:\nThe Endpoint has not attached to the core network yet or the device was previously attached but the visited network signaled that the device had no activity for the last 1-2 days.\nNote: The device is not reachable for external services (e.g. SMS, MSRN lookup).\n\n* `BLOCKED`:\nThe device is not granted service. Endpoints are assigned this status when they have exceeded traffic limits.\n" }, "response": [ { "id": "80c11a62-aba7-4f7c-9f54-342ae03f06f8", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/connectivity", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "connectivity" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": {},\n \"location\": {},\n \"pdp_context\": {},\n \"services\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-80c11a62-aba7-4f7c-9f54-342ae03f06f8" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1dee1e6e-646b-4be7-9398-96fc506eaec6" }, { "name": "Reset endpoint connectivity", "id": "85946d87-e511-4402-a45b-33ccd67ecc0f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"pdp_context\": {\n \"description\": \"Any type\"\n },\n \"location\": {\n \"description\": \"Any type\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/connectivity", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "connectivity" ], "variable": [ { "id": "b2636b9f-fb4d-48c7-bfeb-bca805f46831", "key": "endpoint_id", "value": "", "description": "(Required) " } ] }, "description": "Dispatches a message that causes either a `Cancel Location`, `Delete PDP Context`, or both sent to the endpoint.\nThe return of the call doesn't yet mean the event has been sent towards the device.\n\n\n Master organization types can reset any endpoints inside their organization hierarchy.\n Enterprises may only reset connectivity of own endpoints.\n\n" }, "response": [ { "id": "dbe378f8-78a9-49de-be23-7428d3e574d0", "name": "Successful, no content.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"pdp_context\": {\n \"description\": \"Any type\"\n },\n \"location\": {\n \"description\": \"Any type\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/connectivity", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "connectivity" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-dbe378f8-78a9-49de-be23-7428d3e574d0" }, { "id": "ab3d1ee4-3749-4fdc-9df3-f0db7ca944ea", "name": "Calling organization is not of correct type.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"pdp_context\": {\n \"description\": \"Any type\"\n },\n \"location\": {\n \"description\": \"Any type\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/connectivity", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "connectivity" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ab3d1ee4-3749-4fdc-9df3-f0db7ca944ea" }, { "id": "0c284922-9375-483a-8c00-73f1808728bf", "name": "Endpoint not found.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"pdp_context\": {\n \"description\": \"Any type\"\n },\n \"location\": {\n \"description\": \"Any type\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/connectivity", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "connectivity" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0c284922-9375-483a-8c00-73f1808728bf" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-85946d87-e511-4402-a45b-33ccd67ecc0f" } ], "id": "b8d4139d-3a1c-4622-bc66-cb9b971d0581", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b8d4139d-3a1c-4622-bc66-cb9b971d0581" }, { "name": "connectivity_info", "item": [ { "name": "Retrieve connectivity information for an endpoint", "id": "c115cb1a-3b1a-4148-8f7e-84183d9c129c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/connectivity_info", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "connectivity_info" ], "variable": [ { "id": "22befe7e-0ff1-46d1-8685-5cddf5203a1b", "key": "endpoint_id", "value": "", "description": "(Required) " } ] }, "description": "Returns device location information based on the cell tower to which the device is connected.\n\n\n emnify validates the data requested, sends the signal request to the network operator, and interprets the response.\n Whether the network returns useful data is outside of emnify's control.\n\n To distinguish these cases, this call returns the HTTP `200 OK` response code whenever the request is successfully executed, even if it includes an error.\n See the response body for details.\n\n" }, "response": [ { "id": "3e43a08e-4705-439b-b7f2-eec02fcec7f5", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/connectivity_info", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "connectivity_info" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"subscriber_info\": {\n \"success\": \"\",\n \"state\": \"\",\n \"location\": {\n \"current_location_retrieved\": \"\",\n \"age_of_location\": \"\",\n \"cell_global_id\": {\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"lac\": \"\",\n \"cid\": \"\"\n }\n }\n },\n \"request_timestamp\": \"\",\n \"reply_timestamp\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3e43a08e-4705-439b-b7f2-eec02fcec7f5" }, { "id": "caf5dfff-892b-4f72-94e0-2e99040b5c29", "name": "Endpoint not found.\nThis error often occurs when the requested endpoint ID is incorrect or doesn't exist.\nIt can also happen if you don't have the correct permissions to see the connectivity information or the endpoint doesn't belong to the organization y", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/connectivity_info", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "connectivity_info" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-caf5dfff-892b-4f72-94e0-2e99040b5c29" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c115cb1a-3b1a-4148-8f7e-84183d9c129c" } ], "id": "f30aedb0-24de-4460-92ff-e9dff6b32946", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f30aedb0-24de-4460-92ff-e9dff6b32946" }, { "name": "event", "item": [ { "name": "List endpoint events", "id": "2813ed03-2d14-4fb5-b16e-062ac123f465", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/event?page=&per_page=&sort=&q=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "event" ], "query": [ { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "per_page", "value": "" }, { "description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n", "key": "sort", "value": "" }, { "description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid_with_luhn:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n", "key": "q", "value": "" } ], "variable": [ { "id": "725ed63c-731a-4aef-a8c5-0bc69c8cfffe", "key": "endpoint_id", "value": "", "description": "(Required) Numeric ID of an endpoint" } ] }, "description": "Returns the list of events, filtered, sorted and paged according to query parameters.\n\n\nA full list of events is found in section \"Retrieve Event Types\" (`/api/v1/event/type`).\n\n\n\n This API endpoint deviates from the specified conventions and may not return the same HTTP Codes as the higher layer call (`/api/v1/endpoint/{endpoint_id}`).\n In case the requested `{endpoint_id}` doesn't exist or is not accessible for the user, **HTTP 200** will be returned with empty **[]** as long as the provided `{endpoint_id}` is a number and all parameters are valid.\n\n Please take that into consideration when building automation on top of the error behaviour of this endpoint.\n\n" }, "response": [ { "id": "9b04ea79-39af-419a-b01c-9e8842f1c8fb", "name": "Successfully returned a list of events", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/event?page=&per_page=&sort=&q=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "event" ], "query": [ { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "per_page", "value": "" }, { "description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n", "key": "sort", "value": "" }, { "description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid_with_luhn:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n", "key": "q", "value": "" } ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"timestamp\": \"\",\n \"alert\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"event_type\": {},\n \"event_source\": {},\n \"event_severity\": {},\n \"organisation\": {},\n \"endpoint\": {},\n \"sim\": {},\n \"imsi\": {}\n },\n {\n \"timestamp\": \"\",\n \"alert\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"event_type\": {},\n \"event_source\": {},\n \"event_severity\": {},\n \"organisation\": {},\n \"endpoint\": {},\n \"sim\": {},\n \"imsi\": {}\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9b04ea79-39af-419a-b01c-9e8842f1c8fb" }, { "id": "ebc64514-e38d-46c6-b4d6-73a26d582006", "name": "**Bad Request** due to incorrect **Paging** Parameters, **Sorting** Parameter or incorrect `{endpoint_id}`\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/event?page=&per_page=&sort=&q=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "event" ], "query": [ { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "per_page", "value": "" }, { "description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n", "key": "sort", "value": "" }, { "description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid_with_luhn:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n", "key": "q", "value": "" } ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ebc64514-e38d-46c6-b4d6-73a26d582006" }, { "id": "f038b067-b17f-4665-ab8d-e7629a98ed94", "name": "**Unprocessable Entity** due to incorrect **Query** parameters\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/event?page=&per_page=&sort=&q=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "event" ], "query": [ { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "per_page", "value": "" }, { "description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n", "key": "sort", "value": "" }, { "description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid_with_luhn:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n", "key": "q", "value": "" } ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f038b067-b17f-4665-ab8d-e7629a98ed94" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2813ed03-2d14-4fb5-b16e-062ac123f465" } ], "id": "0ddf3e75-a937-49a8-8d6d-98cb4c0aee9b", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0ddf3e75-a937-49a8-8d6d-98cb4c0aee9b" }, { "name": "operator_blacklist", "item": [ { "name": "{operator_id}", "item": [ { "name": "Add an operator to the blacklist", "id": "9471872f-f452-4948-bfcf-b929e2f11058", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/operator_blacklist/:operator_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "operator_blacklist", ":operator_id" ], "variable": [ { "id": "4613b47d-2f97-46e8-bdfc-e98b86a41c5d", "key": "endpoint_id", "value": "", "description": "(Required) " }, { "id": "58d3b357-e12a-43ac-b80f-d430d7c4cbf8", "key": "operator_id", "value": "", "description": "(Required) " } ] }, "description": "Adds an Operator to the Blacklist of an Endpoint." }, "response": [ { "id": "6378e9d7-9c95-49b9-890c-ea05320f84a9", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/operator_blacklist/:operator_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "operator_blacklist", ":operator_id" ], "variable": [ { "key": "endpoint_id" }, { "key": "operator_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6378e9d7-9c95-49b9-890c-ea05320f84a9" }, { "id": "3d554aa7-32ae-47f1-be1c-816a787d4e5c", "name": "Unexpected error in API call. See HTTP response body for details.", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/operator_blacklist/:operator_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "operator_blacklist", ":operator_id" ], "variable": [ { "key": "endpoint_id" }, { "key": "operator_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3d554aa7-32ae-47f1-be1c-816a787d4e5c" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9471872f-f452-4948-bfcf-b929e2f11058" }, { "name": "Remove an operator from the blacklist", "id": "c6a6cfc5-779c-4de2-9a04-bd785baf0a1d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/operator_blacklist/:operator_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "operator_blacklist", ":operator_id" ], "variable": [ { "id": "3ba5d24c-9837-446b-9b2a-424bb493a564", "key": "endpoint_id", "value": "", "description": "(Required) " }, { "id": "919b918b-81fb-493d-bbc9-59cb56cb615e", "key": "operator_id", "value": "", "description": "(Required) " } ] }, "description": "Remove Operator from the Blacklist of an Endpoint." }, "response": [ { "id": "7e5eb361-8bd8-4c06-9bb8-ceae645da1a2", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/operator_blacklist/:operator_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "operator_blacklist", ":operator_id" ], "variable": [ { "key": "endpoint_id" }, { "key": "operator_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7e5eb361-8bd8-4c06-9bb8-ceae645da1a2" }, { "id": "cff12d20-573b-4512-9239-e888c8883bfd", "name": "Unexpected error in API call. See HTTP response body for details.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/operator_blacklist/:operator_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "operator_blacklist", ":operator_id" ], "variable": [ { "key": "endpoint_id" }, { "key": "operator_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cff12d20-573b-4512-9239-e888c8883bfd" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c6a6cfc5-779c-4de2-9a04-bd785baf0a1d" } ], "id": "f4072a86-ab97-4f47-b626-d1d571224f5b", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f4072a86-ab97-4f47-b626-d1d571224f5b" }, { "name": "List operator blacklist for endpoint", "id": "b5575aff-0d78-43c5-a37b-74b6a99d5ff7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/operator_blacklist", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "operator_blacklist" ], "variable": [ { "id": "1a286441-e66f-4134-8c83-825652474840", "key": "endpoint_id", "value": "", "description": "(Required) " } ] }, "description": "Returns a list of blacklisted Operators for the requested Endpoint" }, "response": [ { "id": "cfceef06-b784-4344-bc08-c83ef4ee0aba", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/operator_blacklist", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "operator_blacklist" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"country\": {}\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"country\": {}\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cfceef06-b784-4344-bc08-c83ef4ee0aba" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b5575aff-0d78-43c5-a37b-74b6a99d5ff7" } ], "id": "81a5310f-41a2-4ef8-9e61-0e435eaf8288", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-81a5310f-41a2-4ef8-9e61-0e435eaf8288" }, { "name": "quota", "item": [ { "name": "data", "item": [ { "name": "Retrieve data quota details", "id": "b1b34628-d0b6-4ffe-a3da-cc7f4ebc5ad6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/quota/data", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "quota", "data" ], "variable": [ { "id": "add6cd0a-cf86-493b-b3be-7ac3febfc1a7", "key": "endpoint_id", "value": "", "description": "(Required) " } ] }, "description": "Returns details about the assigned Data Quota for an endpoint.\n* `status`: this indicates the current status of the quota and may contain the following values:\n - `ACTIVE`: the endpoint can currently connect and has quota left\n - `EXHAUSTED`: the endpoint has exceeded the quota volume, if it still can use data service depends on the action chosen to be performed on exhaustion\n - `EXPIRED`: the quota has expired; the endpoint is denied from using data services (until new quota is added)\n* `volume`: returns the volume left on this quota in MB\n* `expiry_date`: timestamp when this quota will expire and the endpoint will definitely be denied from using further data services (regardless if the quota volume was used up or not)\n* `peak_throughput`: The maximum bandwidth in octets per second after the endpoint has been throttled.\n* `action_on_exhaustion`: returns the behaviour defined to be applied when quota volume is used up (exhausted).\n - `Throttle`: bandwidth will be throttle to the defined peak throughput until quota expires\n - `Block`: data service will be instantly blocked once volume used up, regardless if the expiry date is already reached or not\n* `auto_refill`: 0 (false) / 1 (true), refill the quota with the last added volume on a daily basis\n" }, "response": [ { "id": "cfc34210-47c1-4cd5-b530-18cb736d2661", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/quota/data", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "quota", "data" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": {\n \"id\": \"1\",\n \"description\": \"EXPIRED\"\n },\n \"volume\": \"\",\n \"expiry_date\": \"\",\n \"action_on_exhaustion\": {\n \"id\": \"1\",\n \"description\": \"Block\"\n },\n \"last_volume_added\": \"\",\n \"last_status_change_date\": \"\",\n \"auto_refill\": \"\",\n \"threshold_volume\": \"\",\n \"threshold_percentage\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cfc34210-47c1-4cd5-b530-18cb736d2661" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b1b34628-d0b6-4ffe-a3da-cc7f4ebc5ad6" }, { "name": "Set data quota", "id": "3691812c-5b3f-4065-b6c6-b6f91f97497c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": {\n \"id\": \"2\",\n \"description\": \"EXHAUSTED\"\n },\n \"volume\": \"\",\n \"expiry_date\": \"\",\n \"action_on_exhaustion\": {\n \"id\": \"1\",\n \"description\": \"Block\"\n },\n \"last_volume_added\": \"\",\n \"last_status_change_date\": \"\",\n \"auto_refill\": \"\",\n \"threshold_volume\": \"\",\n \"threshold_percentage\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/quota/data", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "quota", "data" ], "variable": [ { "id": "620e43c6-db75-4bb6-8996-bdda17e5d9cc", "key": "endpoint_id", "value": "", "description": "(Required) " } ] }, "description": "Set a new data quota.\nYou can set a new data quota for a device at any time.\nAt an initial state, when no data quota is set, the device is denied from using data services.\nTo top-up the data volume, you need to retrieve the remaining volume, increase it by the top-up volume, and set it as the new quota volume.\n\n\n We have deprecated throttling as an action on quota exhaustion and the associated peak throughput parameter.\n These were decommissioned as of December 9, 2024.**\n\n\nThe following parameters can be configured:\n* `status` (required) - The status of the quota:\n - 1: `ACTIVE`\n - 2: `EXHAUSTED`\n - 3: `EXPIRED`\n* `volume` - Remaining quota volume in MB\n* `expiry_date` (required) - Timestamp when the quota expires and the device is denied from using further data services\n* `auto_refill` (default: `0`) - Whether the quota should be refilled on a daily basis:\n - `0`: Disabled\n - `1`: Enabled\n* `threshold_percentage` - The remaining quota percentage when the system generates a \"Quota threshold reached\" event\n* `action_on_exhaustion`: Action executed after the quota is exhausted:\n - `id` (required) - Unique identifer of the action on quota exhaustion\n - `1`: Block\n - **DEPRECATED** `2`: Throttle\n - **DEPRECATED** `peak_throughput` - The maximum bandwidth in octets per second after the device has been throttled.\n\n\n **Events**:\n The system generates a \"Quota used up\" event if the data quota is completely depleted.\n Then, the device is blocked from further consumption of data.\n The quota object is included in the event details.\n\n\n\n The device can instantly use data services after successfully making this API call.\n You can set any timestamp with a future date.\n This allows you to create data packages as required (for example, 1 hour, 24 hours, 7 days, or any other timeframe).\n\n" }, "response": [ { "id": "062b1cab-292f-4804-b906-1117c535c75e", "name": "Resource Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"status\": {\n \"id\": \"2\",\n \"description\": \"EXHAUSTED\"\n },\n \"volume\": \"\",\n \"expiry_date\": \"\",\n \"action_on_exhaustion\": {\n \"id\": \"1\",\n \"description\": \"Block\"\n },\n \"last_volume_added\": \"\",\n \"last_status_change_date\": \"\",\n \"auto_refill\": \"\",\n \"threshold_volume\": \"\",\n \"threshold_percentage\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/quota/data", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "quota", "data" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-062b1cab-292f-4804-b906-1117c535c75e" }, { "id": "80766c45-9d5f-44af-979c-c31cd6962dcd", "name": "Unprocessable Entity.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"status\": {\n \"id\": \"2\",\n \"description\": \"EXHAUSTED\"\n },\n \"volume\": \"\",\n \"expiry_date\": \"\",\n \"action_on_exhaustion\": {\n \"id\": \"1\",\n \"description\": \"Block\"\n },\n \"last_volume_added\": \"\",\n \"last_status_change_date\": \"\",\n \"auto_refill\": \"\",\n \"threshold_volume\": \"\",\n \"threshold_percentage\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/quota/data", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "quota", "data" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-80766c45-9d5f-44af-979c-c31cd6962dcd" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3691812c-5b3f-4065-b6c6-b6f91f97497c" }, { "name": "Remove data quota", "id": "4a562d0b-0c42-46a9-b04d-8e9feceb08ad", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/quota/data", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "quota", "data" ], "variable": [ { "id": "0346498e-5c1d-4795-b7c3-0e4fd41a6206", "key": "endpoint_id", "value": "", "description": "(Required) " } ] }, "description": "Will delete the data quota for the endpoint, if any is set.\n\n\n If `apply_data_quota` is still set in the service profile, the endpoint will get blocked from data service.\n\n" }, "response": [ { "id": "fdacb9f0-7f43-4d77-8b48-63c76b34dcee", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/quota/data", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "quota", "data" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-fdacb9f0-7f43-4d77-8b48-63c76b34dcee" }, { "id": "1156da6d-b7c7-4a04-baeb-2ed83f94c7f7", "name": "Can be one of the following reasons:\n- No Data Quota configured\n- Endpoint not found\n- Endpoint not part of this organisation\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/quota/data", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "quota", "data" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1156da6d-b7c7-4a04-baeb-2ed83f94c7f7" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-4a562d0b-0c42-46a9-b04d-8e9feceb08ad" } ], "id": "27b1813e-0470-43d7-948a-1abce83a7cb8", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-27b1813e-0470-43d7-948a-1abce83a7cb8" }, { "name": "sms", "item": [ { "name": "Show SMS quota details", "id": "8370a5d2-e2ef-4437-a130-b42e8ad552fb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/quota/sms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "quota", "sms" ], "variable": [ { "id": "67b38eff-6560-4a93-a985-9dd06ec47f4a", "key": "endpoint_id", "value": "", "description": "(Required) " } ] }, "description": "Returns details about the assigned SMS Quota for an endpoint.\n\nYou can retrieve the current SMS quota status for an endpoint with the following API call. It will return following properties:\n* `status`: this indicates the status of the quota and may contain the following values:\n - `ACTIVE`: the endpoint has quota left and can use SMS services\n - `EXHAUSTED`: the endpoint has exceeded the quota volume; the endpoint is denied from using SMS services (until new quota is added)\n - `EXPIRED`: the quota has expired; the endpoint is denied from using SMS services (until new quota is added)\n* `volume`: the amount of SMS left on this quota\n* `expiry_date`: timestamp when this quota will expire and the endpoint will definitely be denied from using further SMS services (regardless if the quota volume was used up or not)\n* `threshold_percentage`: optional threshold in percentage indicating when a \"Threshold Reached\" event shall be sent.\n* `action_on_exhaustion`: returns the behaviour defined to be applied when quota volume is used up (exhausted).\n - `Throttle`: bandwidth will be throttle to the defined peak throughput until quota expires\n - `Block`: data service will be instantly blocked once volume used up, regardless if the expiry date is already reached or not\n - `auto_refill`: 0 (false) / 1 (true), refill the quota with the last added volume on a daily basis\n" }, "response": [ { "id": "af56b84f-5d54-4e9f-bd32-2929a7ed5510", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/quota/sms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "quota", "sms" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-af56b84f-5d54-4e9f-bd32-2929a7ed5510" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8370a5d2-e2ef-4437-a130-b42e8ad552fb" }, { "name": "Set SMS quota", "id": "dbaa7e40-099d-4b89-aac2-9626465e31e9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"volume\": \"\",\n \"expiry_date\": \"\",\n \"threshold_percentage\": \"\",\n \"status\": {\n \"id\": \"2\",\n \"description\": \"ACTIVE\"\n },\n \"last_volume_added\": \"\",\n \"last_status_change_date\": \"\",\n \"auto_refill\": \"\",\n \"threshold_volume\": \"\",\n \"action_on_exhaustion\": {\n \"id\": \"1\",\n \"description\": \"Block\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/quota/sms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "quota", "sms" ], "variable": [ { "id": "4b517c3f-2853-41d6-9276-c240b3a39025", "key": "endpoint_id", "value": "", "description": "(Required) " } ] }, "description": "At any time, a new SMS quota can be set for an endpoint.\nAt an initial state when no SMS quota is set, the endpoint will be denied from using SMS services.\nTo top-up the SMS volume one need to retrieve the currently left volume, increase it by the top-up volume and set it as the new quota volume.\n\nThe following parameters can be configured:\n* `status` - The status of the quota (mandatory):\n - 1: `ACTIVE`\n - 2: `EXHAUSTED`\n - 3: `EXPIRED`\n* `volume`: The volume left on this quota in MB\n* `expiry_date`: Timestamp when this quota will expire and the endpoint will definitely be denied from using further data services (mandatory)\n* `auto_refill`: Wether the quota shall be refilled on a daily basis (defaults to disabled):\n - 0: `disabled`\n - 1: `enabled`\n* `threshold_percentage`: The percentage of remaining quota at which the system should generate a `threshold reached` event\n* `action_on_exhaustion`: The behaviour of the system after the quota is exhausted:\n - id: ID of the action on quota exhaustion (mandatory)\n - 1: `Block`\n - 2: `Throttle` (will not take any effect on SMS quota)\n - `peak_throughput`: The maximum bandwidth in octets per second after the endpoint has been throttled.\n Allowed values are 64000, 128000, 256000, 384000. (will not take any effect on SMS quota)\n\n\n The endpoint can instantly use the SMS service after the API call is successfully made.\n Any timestamp with a future date can be set, this allows to create SMS packages (e.g. for 1 hour, 24 hour, 7 days or any other timeframe) as required.\n\n" }, "response": [ { "id": "c6c3d9f2-0c6c-49ed-83ee-68e2da841d5a", "name": "Resource Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"volume\": \"\",\n \"expiry_date\": \"\",\n \"threshold_percentage\": \"\",\n \"status\": {\n \"id\": \"2\",\n \"description\": \"ACTIVE\"\n },\n \"last_volume_added\": \"\",\n \"last_status_change_date\": \"\",\n \"auto_refill\": \"\",\n \"threshold_volume\": \"\",\n \"action_on_exhaustion\": {\n \"id\": \"1\",\n \"description\": \"Block\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/quota/sms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "quota", "sms" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c6c3d9f2-0c6c-49ed-83ee-68e2da841d5a" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-dbaa7e40-099d-4b89-aac2-9626465e31e9" }, { "name": "Remove SMS quota", "id": "ee4d15e6-aa6b-4fbc-a91c-54727c6345a3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/quota/sms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "quota", "sms" ], "variable": [ { "id": "5d203097-5c85-4d36-b8d1-74726aa77e01", "key": "endpoint_id", "value": "", "description": "(Required) " } ] }, "description": "Will delete the SMS quota for the endpoint, if any is set.\n\n\n If `apply_sms_quota` is still set in the service profile, the endpoint is blocked from sending SMS.\n\n" }, "response": [ { "id": "1d584fe5-27ad-4025-baca-e197c3b193a4", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/quota/sms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "quota", "sms" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1d584fe5-27ad-4025-baca-e197c3b193a4" }, { "id": "6994f3b2-b118-4b4a-8bb0-10672818d1d2", "name": "Can be one of the following reasons:\n- No SMS Quota configured\n- Endpoint not found\n- Endpoint not part of this organisation\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/quota/sms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "quota", "sms" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6994f3b2-b118-4b4a-8bb0-10672818d1d2" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ee4d15e6-aa6b-4fbc-a91c-54727c6345a3" } ], "id": "27d99ddc-d89c-4886-953d-4c867fa2f9b4", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-27d99ddc-d89c-4886-953d-4c867fa2f9b4" } ], "id": "fdcd7637-4a5e-46e2-acc5-b2ae70dc7d94", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-fdcd7637-4a5e-46e2-acc5-b2ae70dc7d94" }, { "name": "sms", "item": [ { "name": "{sms_id}", "item": [ { "name": "SMS details", "id": "959de59e-539b-4d34-ab0b-2287296bd409", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/sms/:sms_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "sms", ":sms_id" ], "variable": [ { "id": "678c931c-e929-45d4-ac1c-de51927f4a03", "key": "endpoint_id", "value": "", "description": "(Required) " }, { "id": "6fdb632c-598b-459a-8ac1-520e8b9c94b2", "key": "sms_id", "value": "", "description": "(Required) " } ] }, "description": "Returns details about an Endpoint SMS by SMS ID.\n\nA description of the SMS statuses is as follows:\n\n- `1`: Delivery attempt pending\n- `2`: In progress\n- `3`: Buffered\n- `4`: Delivered\n- `5`: Failed\n- `6`: Expired\n- `7`: Canceled\n" }, "response": [ { "id": "da1274b2-e8f3-4ec2-824c-e988e3b46f99", "name": "Response with status 200", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/sms/:sms_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "sms", ":sms_id" ], "variable": [ { "key": "endpoint_id" }, { "key": "sms_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"submit_date\": \"\",\n \"delivery_date\": \"\",\n \"expiry_date\": \"\",\n \"final_date\": \"\",\n \"retry_date\": \"\",\n \"last_delivery_attempt\": \"\",\n \"retry_count\": \"\",\n \"gsm_map_error\": \"\",\n \"dcs\": \"\",\n \"pid\": \"\",\n \"source_address\": \"\",\n \"endpoint\": {},\n \"sim_id\": \"\",\n \"iccid\": \"\",\n \"msisdn\": \"\",\n \"imsi\": \"\",\n \"msc\": \"\",\n \"udh\": \"\",\n \"payload\": \"\",\n \"id\": \"\",\n \"status\": {},\n \"sms_type\": {},\n \"source_address_type\": {}\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-da1274b2-e8f3-4ec2-824c-e988e3b46f99" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-959de59e-539b-4d34-ab0b-2287296bd409" }, { "name": "Cancel SMS", "id": "cf7b438f-2f22-46c9-8e67-a564c9087306", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/sms/:sms_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "sms", ":sms_id" ], "variable": [ { "id": "94092b1c-f737-4db9-8d22-22497787fcb4", "key": "endpoint_id", "value": "", "description": "(Required) " }, { "id": "be502f96-d773-4b64-8c6b-a781ed3a6d11", "key": "sms_id", "value": "", "description": "(Required) " } ] }, "description": "Cancel SMS that is buffered for endpoint and not yet delivered." }, "response": [ { "id": "5b844688-486d-40ff-9c34-e3776d325d51", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/sms/:sms_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "sms", ":sms_id" ], "variable": [ { "key": "endpoint_id" }, { "key": "sms_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5b844688-486d-40ff-9c34-e3776d325d51" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cf7b438f-2f22-46c9-8e67-a564c9087306" } ], "id": "dd5cd2ef-3c22-4ec0-ab43-57149be2aa80", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-dd5cd2ef-3c22-4ec0-ab43-57149be2aa80" }, { "name": "List sent and received SMS", "id": "2f7e9261-f434-4de4-bcd6-254463c13b0a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/sms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "sms" ], "variable": [ { "id": "1cbbb86c-0c0b-4941-9db7-92ca28d3acf3", "key": "endpoint_id", "value": "", "description": "(Required) " } ] }, "description": "Returns the list of SMS sent and received by this endpoint.\n\nA description of the SMS statuses is as follows:\n\n- `1`: Delivery attempt pending\n- `2`: In progress\n- `3`: Buffered\n- `4`: Delivered\n- `5`: Failed\n- `6`: Expired\n- `7`: Canceled\n" }, "response": [ { "id": "bf6840ab-96be-4ac9-a58e-93acfd564968", "name": "Response with status 200", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/sms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "sms" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"submit_date\": \"\",\n \"delivery_date\": \"\",\n \"expiry_date\": \"\",\n \"final_date\": \"\",\n \"retry_date\": \"\",\n \"last_delivery_attempt\": \"\",\n \"retry_count\": \"\",\n \"gsm_map_error\": \"\",\n \"dcs\": \"\",\n \"pid\": \"\",\n \"source_address\": \"\",\n \"endpoint\": {},\n \"sim_id\": \"\",\n \"iccid\": \"\",\n \"msisdn\": \"\",\n \"imsi\": \"\",\n \"msc\": \"\",\n \"udh\": \"\",\n \"payload\": \"\",\n \"id\": \"\",\n \"status\": {},\n \"sms_type\": {},\n \"source_address_type\": {}\n },\n {\n \"submit_date\": \"\",\n \"delivery_date\": \"\",\n \"expiry_date\": \"\",\n \"final_date\": \"\",\n \"retry_date\": \"\",\n \"last_delivery_attempt\": \"\",\n \"retry_count\": \"\",\n \"gsm_map_error\": \"\",\n \"dcs\": \"\",\n \"pid\": \"\",\n \"source_address\": \"\",\n \"endpoint\": {},\n \"sim_id\": \"\",\n \"iccid\": \"\",\n \"msisdn\": \"\",\n \"imsi\": \"\",\n \"msc\": \"\",\n \"udh\": \"\",\n \"payload\": \"\",\n \"id\": \"\",\n \"status\": {},\n \"sms_type\": {},\n \"source_address_type\": {}\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-bf6840ab-96be-4ac9-a58e-93acfd564968" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2f7e9261-f434-4de4-bcd6-254463c13b0a" }, { "name": "Send SMS to an endpoint", "id": "9c382aca-ec5d-4be8-a1bc-4620deaedad2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"payload\": \"\",\n \"source_address\": \"\",\n \"source_address_type\": {\n \"id\": \"\"\n },\n \"dest_address\": \"\",\n \"udh\": \"\",\n \"dcs\": \"\",\n \"expiry_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/sms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "sms" ], "variable": [ { "id": "87991833-10cd-4d91-9635-f172c3d427c0", "key": "endpoint_id", "value": "", "description": "(Required) " } ] }, "description": "Sends a mobile terminating SMS (MT-SMS) to a connected device.\nThe device must have an active SIM with SMS capability enabled in its service profile.\n\n## Use cases\n\n### Standard SMS\n\nSend an SMS with a numeric sender ID.\nSet `source_address` to the sender's phone number (for example, `12345689`) and include your message in `payload`.\n\n### Alphanumeric sender ID\n\nDisplay a custom sender name instead of a phone number.\nSet `source_address` to your brand name (for example, `CompanyName`, up to 11 characters) and include `source_address_type` with `id: 208`.\n\n\nAlphanumeric sender IDs are one-way only.\nRecipients can't reply directly to these messages.\n\n\n### Person-to-Application (P2A) SMS\n\nReceive SMS responses at your server.\nSet `dest_address` with a callback identifier.\nThe platform forwards incoming messages to the API callback URL configured in your service profile.\n\n### Concatenated SMS\n\nSend messages longer than 160 characters by splitting them across multiple API calls.\nEach call requires a `udh` (User Data Header) that identifies the message sequence.\n\nThe UDH format `050003XXYYZZ` contains:\n\n- `XX`: Unique message reference (for example, `CC`)\n- `YY`: Total number of parts (for example, `02` for 2 parts)\n- `ZZ`: Current part number (for example, `01` for part 1)\n\nFor more information, see the [3GPP TS 23.040 specification](https://portal.3gpp.org/desktopmodules/Specifications/SpecificationDetails.aspx?specificationId=747).\n" }, "response": [ { "id": "e481b11e-c43f-444c-a19b-6bcfe19caf74", "name": "Resource Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"payload\": \"\",\n \"source_address\": \"\",\n \"source_address_type\": {\n \"id\": \"\"\n },\n \"dest_address\": \"\",\n \"udh\": \"\",\n \"dcs\": \"\",\n \"expiry_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/sms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "sms" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e481b11e-c43f-444c-a19b-6bcfe19caf74" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9c382aca-ec5d-4be8-a1bc-4620deaedad2" } ], "id": "3b0577c6-6d79-42bb-9eee-97f55ce3287d", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3b0577c6-6d79-42bb-9eee-97f55ce3287d" }, { "name": "stats", "item": [ { "name": "daily", "item": [ { "name": "Retrieve daily usage statistics for an endpoint", "id": "2382d6ef-aeea-4db2-ba10-452002df3242", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/stats/daily?start_date=&end_date=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "stats", "daily" ], "query": [ { "description": "Filters by start date, provided in a `YYYY-MM-DD` format.\n\n\n If you don't define an end date, the response will include 6 months of data, beginning on the current date.\n\n", "key": "start_date", "value": "" }, { "description": "Filters by end date, provided in an `YYYY-MM-DD` format.\n\n\n If you don't define a start date, the response will only return data from the month indicated in your end date.\n\n", "key": "end_date", "value": "" } ], "variable": [ { "id": "64e449cc-e4bf-4307-943c-16167de88513", "key": "endpoint_id", "value": "", "description": "(Required) " } ] }, "description": "Returns daily usage statistics for a specific endpoint, including cellular data and SMS volumes.\n\nBy default, returns statistics for the current month.\nUse `start_date` and `end_date` query parameters to specify a custom date range.\n\n\n Data traffic cost statistics (`cost` field in the `data` object) have been deprecated.\n\n" }, "response": [ { "id": "1299415f-14e0-4265-ade8-5e66f9ffa5d7", "name": "Successfully returned the daily endpoint statistics.\n\nEach day's entry contains:\n\n- `date`: The date in YYYY-MM-DD format\n- `data`: Cellular data usage (volume in MB)\n- `sms`: SMS usage (volume as message count)\n- `sat_geo_data`: Satellite data usage, if ", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/stats/daily?start_date=&end_date=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "stats", "daily" ], "query": [ { "description": "Filters by start date, provided in a `YYYY-MM-DD` format.\n\n\n If you don't define an end date, the response will include 6 months of data, beginning on the current date.\n\n", "key": "start_date", "value": "" }, { "description": "Filters by end date, provided in an `YYYY-MM-DD` format.\n\n\n If you don't define a start date, the response will only return data from the month indicated in your end date.\n\n", "key": "end_date", "value": "" } ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"date\": \"\",\n \"data\": {\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"cost\": \"\",\n \"traffic_type\": {\n \"id\": \"\",\n \"description\": \"\",\n \"unit\": \"\"\n },\n \"currency\": {\n \"id\": \"\",\n \"code\": \"\",\n \"symbol\": \"\"\n }\n },\n \"sms\": {\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"cost\": \"\",\n \"traffic_type\": {\n \"id\": \"\",\n \"description\": \"\",\n \"unit\": \"\"\n },\n \"currency\": {\n \"id\": \"\",\n \"code\": \"\",\n \"symbol\": \"\"\n }\n },\n \"sat_geo_data\": {\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"cost\": \"\"\n },\n \"sat_geo_sms\": {\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"cost\": \"\"\n }\n },\n {\n \"date\": \"\",\n \"data\": {\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"cost\": \"\",\n \"traffic_type\": {\n \"id\": \"\",\n \"description\": \"\",\n \"unit\": \"\"\n },\n \"currency\": {\n \"id\": \"\",\n \"code\": \"\",\n \"symbol\": \"\"\n }\n },\n \"sms\": {\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"cost\": \"\",\n \"traffic_type\": {\n \"id\": \"\",\n \"description\": \"\",\n \"unit\": \"\"\n },\n \"currency\": {\n \"id\": \"\",\n \"code\": \"\",\n \"symbol\": \"\"\n }\n },\n \"sat_geo_data\": {\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"cost\": \"\"\n },\n \"sat_geo_sms\": {\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"cost\": \"\"\n }\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1299415f-14e0-4265-ade8-5e66f9ffa5d7" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2382d6ef-aeea-4db2-ba10-452002df3242" } ], "id": "b4524f43-2bfe-4890-88a7-5a9da0b49574", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b4524f43-2bfe-4890-88a7-5a9da0b49574" }, { "name": "Endpoint usage and cost statistics", "id": "abc97014-29c9-44a6-80cb-01f9fbd99734", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "stats" ], "variable": [ { "id": "22bf98db-32c7-440a-9ce7-d2c1b471defd", "key": "endpoint_id", "value": "", "description": "(Required) " } ] }, "description": "\n You can only retrieve data traffic costs for organizations without multi-inclusive volumes.\n\n\nRetrieves endpoint usage and cost statistics for a given ID.\nUsage statistics are sorted by `data` and `sms`.\n\nReturns statistics from the following periods:\n\n- `last_month`: Previous billing month, from the first to last day (for example, April 1-30, 2023, when you send the request sometime in May 2023).\n- `current_month`: Current month, with statistics calculated up to and including the date requested (for example, May 1-8, 2023, when you sent the request on May 8, 2023).\n- `last_hour`: Previous 60 minutes, accumulated per minute and organized by data or SMS received by the device (`rx`) and transmitted by the device (`tx`).\n\n\n `last_month` and `current_month` are only included in the responses if traffic exists.\n\n" }, "response": [ { "id": "84f81acd-f554-4fef-b883-baa3ecc60c5a", "name": "Successfully returned the endpoint statistics associated with the provided `id`.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "stats" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"last_month\": {},\n \"current_month\": {},\n \"last_hour\": {}\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-84f81acd-f554-4fef-b883-baa3ecc60c5a" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-abc97014-29c9-44a6-80cb-01f9fbd99734" } ], "id": "a7e7ae08-8365-4c04-9368-49de21d2f1f1", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a7e7ae08-8365-4c04-9368-49de21d2f1f1" }, { "name": "traffic_limit_extension", "item": [ { "name": "List active traffic limit extensions", "id": "60c73154-19ed-4b98-8aa2-c9ecd0d17aad", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/traffic_limit_extension", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "traffic_limit_extension" ], "variable": [ { "id": "1ce42e06-03aa-4f69-9b83-19cd54b075f1", "key": "endpoint_id", "value": "", "description": "(Required) " } ] }, "description": "Returns all active traffic limit extensions for an endpoint, if any exist.\n\nOnly accessible by users with Administrator, User or Observer roles who belong to the endpoint's organization.\n" }, "response": [ { "id": "bf19159e-0112-4b05-b9a4-e3e3faaf109f", "name": "Successfully returned traffic limit extension details", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/traffic_limit_extension", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "traffic_limit_extension" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"endpoint_id\": \"\",\n \"traffic_limit_id\": \"\",\n \"volume\": \"\",\n \"expiration_date\": \"\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"endpoint_id\": \"\",\n \"traffic_limit_id\": \"\",\n \"volume\": \"\",\n \"expiration_date\": \"\",\n \"created_at\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-bf19159e-0112-4b05-b9a4-e3e3faaf109f" }, { "id": "a012abe9-7aca-41ba-b9ea-e071c9f49b17", "name": "No or invalid authentication token provided", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/traffic_limit_extension", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "traffic_limit_extension" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a012abe9-7aca-41ba-b9ea-e071c9f49b17" }, { "id": "bb6518e2-5e0f-48d0-af6a-f26bbc08648f", "name": "Authentication token is valid, but user has no access permissions to the request resource", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/traffic_limit_extension", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "traffic_limit_extension" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-bb6518e2-5e0f-48d0-af6a-f26bbc08648f" }, { "id": "dbfad49b-e1e9-4ed3-952f-2ede3a605892", "name": "Endpoint not found or does not belong to user's organization", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/traffic_limit_extension", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "traffic_limit_extension" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-dbfad49b-e1e9-4ed3-952f-2ede3a605892" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-60c73154-19ed-4b98-8aa2-c9ecd0d17aad" }, { "name": "Create traffic limit extension", "id": "e7db0e4b-b3e3-4f66-ae7c-654a32e7d137", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"volume\": \"\",\n \"traffic_limit_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/traffic_limit_extension", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "traffic_limit_extension" ], "variable": [ { "id": "8c032b7b-8b3b-4204-85ee-219fb0b25f38", "key": "endpoint_id", "value": "", "description": "(Required) " } ] }, "description": "Creates a temporary traffic limit extension for an endpoint.\n\nOnly accessible by users with Administrator or User roles who belong to the endpoint's organization.\n\nRequired fields:\n* `volume` - The traffic volume limit\n" }, "response": [ { "id": "208cc4ac-48f4-463f-9f01-98955b5fa24d", "name": "Traffic limit extension created successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"volume\": \"\",\n \"traffic_limit_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/traffic_limit_extension", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "traffic_limit_extension" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"endpoint_id\": \"\",\n \"traffic_limit_id\": \"\",\n \"volume\": \"\",\n \"expiration_date\": \"\",\n \"created_at\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-208cc4ac-48f4-463f-9f01-98955b5fa24d" }, { "id": "26451a92-45b5-4be3-92ec-33398a02a8dc", "name": "Invalid request body", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"volume\": \"\",\n \"traffic_limit_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/traffic_limit_extension", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "traffic_limit_extension" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-26451a92-45b5-4be3-92ec-33398a02a8dc" }, { "id": "0a301124-6ffe-476d-842d-60904df74dce", "name": "No or invalid authentication token provided", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"volume\": \"\",\n \"traffic_limit_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/traffic_limit_extension", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "traffic_limit_extension" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0a301124-6ffe-476d-842d-60904df74dce" }, { "id": "c626e42c-2476-49cd-ac2a-5c241723eb91", "name": "Authentication token is valid, but user has no access permissions to the request resource", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"volume\": \"\",\n \"traffic_limit_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/traffic_limit_extension", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "traffic_limit_extension" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c626e42c-2476-49cd-ac2a-5c241723eb91" }, { "id": "f8c839c7-c51e-49c2-aaf7-0d50cbe5eef8", "name": "Endpoint not found or does not belong to user's organization", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"volume\": \"\",\n \"traffic_limit_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/traffic_limit_extension", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "traffic_limit_extension" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f8c839c7-c51e-49c2-aaf7-0d50cbe5eef8" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e7db0e4b-b3e3-4f66-ae7c-654a32e7d137" }, { "name": "Delete all traffic limit extensions for an endpoint", "id": "748f9b98-cce8-4b1a-85ff-f817d9246b7a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/traffic_limit_extension", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "traffic_limit_extension" ], "variable": [ { "id": "5e58a2d2-b7f9-43e7-a8c3-4a18679109dd", "key": "endpoint_id", "value": "", "description": "(Required) " } ] }, "description": "Removes all traffic limit extensions from an endpoint.\n\nOnly accessible by users with Administrator or User roles who belong to the endpoint's organization.\n\nThe endpoint's traffic limits will revert to their original values defined in the service profile.\n" }, "response": [ { "id": "70e1fd34-e458-4925-a7bf-b0e308d59442", "name": "Traffic limit extensions successfully removed", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/traffic_limit_extension", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "traffic_limit_extension" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-70e1fd34-e458-4925-a7bf-b0e308d59442" }, { "id": "87449cb8-da53-49c9-a4e0-e4897bebfa21", "name": "No or invalid authentication token provided", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/traffic_limit_extension", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "traffic_limit_extension" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-87449cb8-da53-49c9-a4e0-e4897bebfa21" }, { "id": "8e7256a8-cf90-4e3d-95a6-b4889160d2fb", "name": "Authentication token is valid, but user has no access permissions to the request resource", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/traffic_limit_extension", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "traffic_limit_extension" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8e7256a8-cf90-4e3d-95a6-b4889160d2fb" }, { "id": "27a7301c-d5a2-49df-a933-6a35d5942255", "name": "Endpoint not found or does not belong to user's organization", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id/traffic_limit_extension", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id", "traffic_limit_extension" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-27a7301c-d5a2-49df-a933-6a35d5942255" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-748f9b98-cce8-4b1a-85ff-f817d9246b7a" } ], "id": "eb8ba53b-767e-42e9-a47b-3f8ba3a57a09", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-eb8ba53b-767e-42e9-a47b-3f8ba3a57a09" }, { "name": "Endpoint details", "id": "bb97c59b-ca6a-41f4-bd03-0dc51aa7bf34", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id" ], "variable": [ { "id": "df71f2dc-0d47-46a9-90ba-75d5ea733ea2", "key": "endpoint_id", "value": "", "description": "(Required) " } ] }, "description": "Retrieves endpoint details for a given ID." }, "response": [ { "id": "b20e7a58-d3af-4d9b-825a-304a79adfd83", "name": "Successfully returned the endpoint details associated with the provided `id`.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"service_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"name\": \"\",\n \"tags\": \"\",\n \"created\": \"\",\n \"last_updated\": \"\",\n \"ip_address\": \"\",\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"sim\": {\n \"id\": \"\",\n \"iccid\": \"\",\n \"eid\": \"\",\n \"msisdn\": \"\",\n \"imsi\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n }\n },\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"runtime_data\": {\n \"msc\": \"\",\n \"sgsn\": \"\",\n \"sgsn_ip_address\": \"\"\n }\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b20e7a58-d3af-4d9b-825a-304a79adfd83" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-bb97c59b-ca6a-41f4-bd03-0dc51aa7bf34" }, { "name": "Delete an endpoint", "id": "a3d1ba6e-547b-423c-8558-8e96a2920280", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id" ], "variable": [ { "id": "a84461ab-f142-43a6-8d7a-b943e093cfde", "key": "endpoint_id", "value": "", "description": "(Required) " } ] }, "description": "Deletes an endpoint and all its child entities.\n\n\n Execute this operation sequentially - wait for each request to complete before starting the next.\n\n For bulk deletions, use [`DELETE /api/v2/endpoint/multi`](/developers/api/endpoint/bulk-delete-endpoint) instead (supports up to 2,000 endpoints).\n\n\n\n Endpoints with an assigned SIM cannot be deleted (results in a `409` error).\n\n" }, "response": [ { "id": "c8826d98-ecf8-4d0b-bc84-08cb27a21c8c", "name": "Endpoints deleted successfully.\nThe response payload body should be empty.\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c8826d98-ecf8-4d0b-bc84-08cb27a21c8c" }, { "id": "7c89d7fb-9c28-4d20-b674-88a993c0aba6", "name": "Request body is malformed\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7c89d7fb-9c28-4d20-b674-88a993c0aba6" }, { "id": "b26baa3a-b895-41a5-b5e3-71a9a7b9eff6", "name": "Requested endpoint ID wasn't found\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b26baa3a-b895-41a5-b5e3-71a9a7b9eff6" }, { "id": "9d44c615-17c9-48f0-9ee3-44ef44211ef8", "name": "Requested endpoint is still referenced (for example, there is an assigned SIM)\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9d44c615-17c9-48f0-9ee3-44ef44211ef8" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a3d1ba6e-547b-423c-8558-8e96a2920280" }, { "name": "Update an endpoint", "id": "5d752a8e-cce4-443f-b20f-f15127b8744c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"sim\": {\n \"id\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n },\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"ip_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id" ], "variable": [ { "id": "2567b39e-2585-450c-9144-d9092e995884", "key": "endpoint_id", "value": "", "description": "(Required) " } ] }, "description": "Updates the details of an endpoint.\n\n\n Execute this operation sequentially - wait for each request to complete before starting the next.\n\n For bulk updates, use [`PATCH /api/v2/endpoint/multi`](/developers/api/endpoint/bulk-update-endpoint) instead (supports up to 2,000 endpoints).\n\n\n\n emnify charges for activated SIMs, even if the endpoint `status` is set to **Disabled**.\n To avoid accruing unexpected charges, update the SIM `status` to **Suspended** (`\"id\": 2`).\n\n" }, "response": [ { "id": "89af0e06-e863-4448-bcba-3e9cce45e32d", "name": "Endpoint updated successfully", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"sim\": {\n \"id\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n },\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"ip_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-89af0e06-e863-4448-bcba-3e9cce45e32d" }, { "id": "8643e594-ade4-4486-823f-f329c6eda5ec", "name": "Request body is malformed", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"sim\": {\n \"id\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n },\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"ip_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8643e594-ade4-4486-823f-f329c6eda5ec" }, { "id": "9906777a-fe2b-4f0f-84a0-fc2191099d0e", "name": "User doesn't have permission to bulk update endpoints\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"sim\": {\n \"id\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n },\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"ip_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9906777a-fe2b-4f0f-84a0-fc2191099d0e" }, { "id": "ac6d1744-3f98-44d4-973e-de53fe16e317", "name": "Appears in one of the following cases:\n\n- IP address space isn't found\n- IP address space is full\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"sim\": {\n \"id\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n },\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"ip_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ac6d1744-3f98-44d4-973e-de53fe16e317" }, { "id": "e59108b6-48c9-4495-9bdd-b24f6224c238", "name": "Appears in one of the following cases:\n\n- Service profile is invalid\n- Tariff profile is invalid\n- Status is invalid\n- IP address space is invalid\n- IP address is invalid\n- SIM is invalid\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"sim\": {\n \"id\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n },\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"ip_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint/:endpoint_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint", ":endpoint_id" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e59108b6-48c9-4495-9bdd-b24f6224c238" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5d752a8e-cce4-443f-b20f-f15127b8744c" } ], "id": "afe87a80-a933-43ee-b278-1b9fc0e52f89", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-afe87a80-a933-43ee-b278-1b9fc0e52f89" }, { "name": "List endpoints", "id": "b62754c3-504b-45db-8967-8c9080a991d5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint?q=&sort=&page=1&per_page=1000", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint" ], "query": [ { "description": "Filters endpoints by field value.\nUse `:` format.\nCombine multiple filters with commas (for example, `status:0,tags:sensor`).\n", "key": "q", "value": "" }, { "description": "Sorts endpoints by field value.\nUse `` format.\nCombine multiple sort fields with commas (for example, `-status,id`).\n\n**Operators:**\n- `-` descending (Z-A for text, highest number first)\n- `+` ascending (A-Z for text, lowest number first)\n\nDefaults to ascending order if no operator is specified.\nDefaults to `id` if no sort field is specified.\nEndpoints with identical values are sorted by ascending `id`.\n", "key": "sort", "value": "" }, { "description": "Page number to retrieve.\nStarts at 1.\n", "key": "page", "value": "1" }, { "description": "Number of endpoints to return per page.", "key": "per_page", "value": "1000" } ] }, "description": "Retrieves all endpoints for your organization.\nUse the query parameters to filter, sort, and paginate results.\n" }, "response": [ { "id": "a75f9a07-041a-4872-8af3-134bc9aeb895", "name": "Returns an array of endpoint objects.\nPagination metadata is included in the response headers.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/endpoint?q=&sort=&page=1&per_page=1000", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint" ], "query": [ { "description": "Filters endpoints by field value.\nUse `:` format.\nCombine multiple filters with commas (for example, `status:0,tags:sensor`).\n", "key": "q", "value": "" }, { "description": "Sorts endpoints by field value.\nUse `` format.\nCombine multiple sort fields with commas (for example, `-status,id`).\n\n**Operators:**\n- `-` descending (Z-A for text, highest number first)\n- `+` ascending (A-Z for text, lowest number first)\n\nDefaults to ascending order if no operator is specified.\nDefaults to `id` if no sort field is specified.\nEndpoints with identical values are sorted by ascending `id`.\n", "key": "sort", "value": "" }, { "description": "Page number to retrieve.\nStarts at 1.\n", "key": "page", "value": "1" }, { "description": "Number of endpoints to return per page.", "key": "per_page", "value": "1000" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"service_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"last_updated\": \"\",\n \"name\": \"\",\n \"tags\": \"\",\n \"ip_address\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"tag_assignments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"tag_color\": {\n \"id\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"tag_color\": {\n \"id\": \"\"\n }\n }\n ],\n \"sim\": {\n \"id\": \"\",\n \"iccid\": \"\",\n \"iccid_with_luhn\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"imsi\": \"\",\n \"eid\": \"\",\n \"msisdn\": \"\",\n \"sim_profile_type\": {\n \"id\": \"\"\n },\n \"euicc_profile_data\": {}\n },\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"imei_with_luhn\": \"\",\n \"runtime_data\": {\n \"msc\": \"\",\n \"sgsn\": \"\",\n \"sgsn_ip_address\": \"\"\n }\n },\n {\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"service_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"last_updated\": \"\",\n \"name\": \"\",\n \"tags\": \"\",\n \"ip_address\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"tag_assignments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"tag_color\": {\n \"id\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"tag_color\": {\n \"id\": \"\"\n }\n }\n ],\n \"sim\": {\n \"id\": \"\",\n \"iccid\": \"\",\n \"iccid_with_luhn\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"imsi\": \"\",\n \"eid\": \"\",\n \"msisdn\": \"\",\n \"sim_profile_type\": {\n \"id\": \"\"\n },\n \"euicc_profile_data\": {}\n },\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"imei_with_luhn\": \"\",\n \"runtime_data\": {\n \"msc\": \"\",\n \"sgsn\": \"\",\n \"sgsn_ip_address\": \"\"\n }\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a75f9a07-041a-4872-8af3-134bc9aeb895" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b62754c3-504b-45db-8967-8c9080a991d5" }, { "name": "Create an endpoint", "id": "d7232dfa-fcbb-449b-aa7e-93d2bb4ed15b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": false,\n \"sim\": {\n \"id\": \"\",\n \"activate\": false,\n \"status\": {\n \"id\": \"\"\n }\n },\n \"ip_address\": \"\",\n \"organisation\": {\n \"id\": \"\"\n },\n \"ip_address_space\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint" ] }, "description": "Creates a single endpoint with the specified configuration.\n\n\n For bulk operations, use [`POST /api/v2/endpoint/multi`](/developers/api/endpoint/bulk-create-endpoint) instead (supports up to 2,000 endpoints per request).\n\n\n\n emnify charges for activated SIMs, even if the endpoint status is set to **Disabled**.\n\n" }, "response": [ { "id": "e3c1b17a-3704-45f9-b458-2aafbca9b637", "name": "Endpoint created successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": false,\n \"sim\": {\n \"id\": \"\",\n \"activate\": false,\n \"status\": {\n \"id\": \"\"\n }\n },\n \"ip_address\": \"\",\n \"organisation\": {\n \"id\": \"\"\n },\n \"ip_address_space\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"ip_address\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"created\": \"\",\n \"last_updated\": \"\",\n \"imei_lock\": \"\",\n \"service_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\",\n \"name\": \"\",\n \"satellite_capable\": \"\"\n },\n \"sim\": {\n \"id\": \"\",\n \"iccid\": \"\",\n \"iccid_with_luhn\": \"\",\n \"sim_profile_type_id\": \"\",\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n }\n },\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"imei_with_luhn\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e3c1b17a-3704-45f9-b458-2aafbca9b637" }, { "id": "22b2f96a-cec8-4297-96d9-4ad39c2cc934", "name": "Request body is malformed.\nCheck JSON syntax.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": false,\n \"sim\": {\n \"id\": \"\",\n \"activate\": false,\n \"status\": {\n \"id\": \"\"\n }\n },\n \"ip_address\": \"\",\n \"organisation\": {\n \"id\": \"\"\n },\n \"ip_address_space\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-22b2f96a-cec8-4297-96d9-4ad39c2cc934" }, { "id": "17db3f42-a422-4911-bd25-6c8947857c94", "name": "IP address space is full, in use for creating another endpoint or the resource wasn't found.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": false,\n \"sim\": {\n \"id\": \"\",\n \"activate\": false,\n \"status\": {\n \"id\": \"\"\n }\n },\n \"ip_address\": \"\",\n \"organisation\": {\n \"id\": \"\"\n },\n \"ip_address_space\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-17db3f42-a422-4911-bd25-6c8947857c94" }, { "id": "7a88f32a-87ca-4cc1-9859-386df0db34cd", "name": "Validation failed.\nPossible causes:\n\n- Invalid service profile, tariff profile, or status ID\n- Invalid IP address space or organization ID\n- Endpoint data is invalid\n- Organization doesn't belong to your reseller\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": false,\n \"sim\": {\n \"id\": \"\",\n \"activate\": false,\n \"status\": {\n \"id\": \"\"\n }\n },\n \"ip_address\": \"\",\n \"organisation\": {\n \"id\": \"\"\n },\n \"ip_address_space\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/endpoint", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "endpoint" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n }\n ],\n \"status_code\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7a88f32a-87ca-4cc1-9859-386df0db34cd" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d7232dfa-fcbb-449b-aa7e-93d2bb4ed15b" } ], "id": "9a671afe-335f-40ec-818e-2f7b1d29f381", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9a671afe-335f-40ec-818e-2f7b1d29f381" }, { "name": "esme_interface_type", "item": [ { "name": "List ESME interface types", "id": "4bd588fd-1349-4ec7-9643-ad68088567aa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/esme_interface_type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "esme_interface_type" ] }, "description": "Provides the list of available ESME interface types." }, "response": [ { "id": "565535d0-debe-4e53-a6a9-f65c14da78ad", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/esme_interface_type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "esme_interface_type" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-565535d0-debe-4e53-a6a9-f65c14da78ad" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-4bd588fd-1349-4ec7-9643-ad68088567aa" } ], "id": "68510e77-a8a8-4442-94d3-abce83293386", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-68510e77-a8a8-4442-94d3-abce83293386" }, { "name": "euicc", "item": [ { "name": "operation", "item": [ { "name": "action", "item": [ { "name": "List operation action for eUICC", "id": "8451f886-6135-4559-9744-636475992b2d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/operation/action", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "operation", "action" ] }, "description": "List possible IoT eUICC action objects used in responses and requests.\n" }, "response": [ { "id": "23cad91c-cb9d-4e51-afa8-87a9887f6f1d", "name": "List of operation action for eUICC", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/operation/action", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "operation", "action" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-23cad91c-cb9d-4e51-afa8-87a9887f6f1d" }, { "id": "8ec47c4b-7607-4730-aaa3-71091629352f", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/operation/action", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "operation", "action" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8ec47c4b-7607-4730-aaa3-71091629352f" }, { "id": "bac567c6-6273-450e-9afd-87116747d4f1", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/operation/action", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "operation", "action" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-bac567c6-6273-450e-9afd-87116747d4f1" }, { "id": "8408e946-4691-447a-8f6a-7ba375638c46", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/operation/action", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "operation", "action" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8408e946-4691-447a-8f6a-7ba375638c46" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8451f886-6135-4559-9744-636475992b2d" } ], "id": "ec1408c2-b241-41a7-b7fd-9b99630c8969", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ec1408c2-b241-41a7-b7fd-9b99630c8969" }, { "name": "status", "item": [ { "name": "List operation status for eUICC", "id": "ab792c7d-c164-4303-a706-c9023c32b80b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/operation/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "operation", "status" ] }, "description": "List possible IoT eUICC operation status objects used in responses.\n" }, "response": [ { "id": "d0eb0ba0-3d8b-4c49-abc6-26c9c796665d", "name": "List of operation status for eUICC", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/operation/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "operation", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d0eb0ba0-3d8b-4c49-abc6-26c9c796665d" }, { "id": "c55eb2e3-cb92-41cf-8495-49501526ef1a", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/operation/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "operation", "status" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c55eb2e3-cb92-41cf-8495-49501526ef1a" }, { "id": "630d606d-0b8b-48e3-8ffd-06907c24fe8d", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/operation/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "operation", "status" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-630d606d-0b8b-48e3-8ffd-06907c24fe8d" }, { "id": "f8f34bfa-e963-42e5-a705-8143142cbe8f", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/operation/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "operation", "status" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f8f34bfa-e963-42e5-a705-8143142cbe8f" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ab792c7d-c164-4303-a706-c9023c32b80b" } ], "id": "2c69ccbe-048f-47bc-872f-ca3de0e817df", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2c69ccbe-048f-47bc-872f-ca3de0e817df" } ], "id": "01fd9040-9fad-45aa-9aea-e29d11aeef04", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-01fd9040-9fad-45aa-9aea-e29d11aeef04" }, { "name": "profile", "item": [ { "name": "status", "item": [ { "name": "List eUICC Profile status", "id": "e67a6586-c10c-4ba9-b4fb-c4285d7465de", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/profile/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "profile", "status" ] }, "description": "List possible eUICC Profile statuses.\n" }, "response": [ { "id": "0cc011e3-53e6-4ea8-8b90-5de7572b78c0", "name": "List of eUICC Profile statuses", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/profile/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "profile", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0cc011e3-53e6-4ea8-8b90-5de7572b78c0" }, { "id": "f1080e6c-5505-4675-96a7-644ca2917a63", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/profile/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "profile", "status" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f1080e6c-5505-4675-96a7-644ca2917a63" }, { "id": "de8002c6-19f9-4119-9cfe-c0999d44adc6", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/profile/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "profile", "status" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-de8002c6-19f9-4119-9cfe-c0999d44adc6" }, { "id": "315acd40-50e8-4e20-9f42-4bad6cb9ed8f", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/profile/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "profile", "status" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-315acd40-50e8-4e20-9f42-4bad6cb9ed8f" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e67a6586-c10c-4ba9-b4fb-c4285d7465de" } ], "id": "5607a53b-4387-4ac6-970b-bfa0666f50ad", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5607a53b-4387-4ac6-970b-bfa0666f50ad" } ], "id": "270faca3-bc64-445e-96ba-624a040142fd", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-270faca3-bc64-445e-96ba-624a040142fd" }, { "name": "status", "item": [ { "name": "List eUICC status", "id": "9af8d5bc-fb21-47a2-ba6b-8b2479209309", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "status" ] }, "description": "List possible eUICC statuses (reserved for future use).\n" }, "response": [ { "id": "f6f6a7eb-a4ab-42ad-93cd-ccf7f5cf475d", "name": "List of eUICC statuses", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f6f6a7eb-a4ab-42ad-93cd-ccf7f5cf475d" }, { "id": "e64cf0b4-0c4f-497b-bb9c-05ad6139c83a", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "status" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e64cf0b4-0c4f-497b-bb9c-05ad6139c83a" }, { "id": "73bb9a8e-b434-4987-a7bf-070a84e75919", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "status" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-73bb9a8e-b434-4987-a7bf-070a84e75919" }, { "id": "ed79e751-d82a-457a-a901-2a87e84a1d76", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "status" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ed79e751-d82a-457a-a901-2a87e84a1d76" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9af8d5bc-fb21-47a2-ba6b-8b2479209309" } ], "id": "46358ac7-705b-40b2-94e3-36d7258533bc", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-46358ac7-705b-40b2-94e3-36d7258533bc" }, { "name": "unlinked_validation", "item": [ { "name": "Unlinked eUICC validation", "id": "977f9b5e-d608-49bb-bc80-110db9b66c90", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"target\": [\n {\n \"eid\": \"\"\n },\n {\n \"eid\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/euicc/unlinked_validation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "unlinked_validation" ] }, "description": "Validate whether the specified eUICCs do not have any existing profiles linked.\n" }, "response": [ { "id": "936f58a4-cc67-4795-9175-64c649a1840d", "name": "Validation response containing EIDs that already have linked profiles", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"target\": [\n {\n \"eid\": \"\"\n },\n {\n \"eid\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/euicc/unlinked_validation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "unlinked_validation" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"eid\": \"\"\n },\n {\n \"eid\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-936f58a4-cc67-4795-9175-64c649a1840d" }, { "id": "24de6c44-ece9-4403-ab5d-3bfb51ae61f5", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"target\": [\n {\n \"eid\": \"\"\n },\n {\n \"eid\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/euicc/unlinked_validation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "unlinked_validation" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-24de6c44-ece9-4403-ab5d-3bfb51ae61f5" }, { "id": "5bb34a2a-c5e1-4c05-b458-1f88a6d6e78f", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"target\": [\n {\n \"eid\": \"\"\n },\n {\n \"eid\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/euicc/unlinked_validation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "unlinked_validation" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5bb34a2a-c5e1-4c05-b458-1f88a6d6e78f" }, { "id": "97a9cb72-ec16-4bd4-8676-1ed1a56db871", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"target\": [\n {\n \"eid\": \"\"\n },\n {\n \"eid\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/euicc/unlinked_validation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "unlinked_validation" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-97a9cb72-ec16-4bd4-8676-1ed1a56db871" }, { "id": "40a94515-956f-47bd-b808-2029ef0e757b", "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"target\": [\n {\n \"eid\": \"\"\n },\n {\n \"eid\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/euicc/unlinked_validation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", "unlinked_validation" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-40a94515-956f-47bd-b808-2029ef0e757b" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-977f9b5e-d608-49bb-bc80-110db9b66c90" } ], "id": "16230966-74a9-4cf3-a58f-ced8d41ce356", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-16230966-74a9-4cf3-a58f-ced8d41ce356" }, { "name": "{euicc_id}", "item": [ { "name": "operation", "item": [ { "name": "{operation_id}", "item": [ { "name": "Get operation details", "id": "1edd53f7-4090-4600-966b-158dc3c5cdcf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation/:operation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation", ":operation_id" ], "variable": [ { "id": "76745e3d-f51c-4f24-aa07-94b0d335a5fd", "key": "euicc_id", "value": "", "description": "(Required) " }, { "id": "8b0718f6-9d94-4ba9-917c-083ad5b5e6b4", "key": "operation_id", "value": "", "description": "(Required) " } ] }, "description": "Get details of specific operation for a specific IoT eUICC.\nThis route returns HTTP 404 error for non-IoT eUICCs.\n" }, "response": [ { "id": "82771c04-c320-4ea4-bc7b-7aa489d7f764", "name": "Operation detail", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation/:operation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation", ":operation_id" ], "variable": [ { "key": "euicc_id" }, { "key": "operation_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"action\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"creation_date\": \"\",\n \"last_updated_at\": \"\",\n \"user\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"expiry_date\": \"\",\n \"finalization_date\": \"\",\n \"error\": {\n \"reason\": \"\",\n \"message\": \"\"\n },\n \"iccid_with_luhn\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-82771c04-c320-4ea4-bc7b-7aa489d7f764" }, { "id": "9a9c2c4c-31d8-4649-9903-7d0cca2f03b9", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation/:operation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation", ":operation_id" ], "variable": [ { "key": "euicc_id" }, { "key": "operation_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9a9c2c4c-31d8-4649-9903-7d0cca2f03b9" }, { "id": "f0c0d8e5-d6dd-43fe-bb9f-d0c330d19296", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation/:operation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation", ":operation_id" ], "variable": [ { "key": "euicc_id" }, { "key": "operation_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f0c0d8e5-d6dd-43fe-bb9f-d0c330d19296" }, { "id": "c49911cd-a454-4052-8975-a144b0c1b449", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation/:operation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation", ":operation_id" ], "variable": [ { "key": "euicc_id" }, { "key": "operation_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c49911cd-a454-4052-8975-a144b0c1b449" }, { "id": "5072048c-1ae7-4256-b07c-d3a29d695c02", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation/:operation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation", ":operation_id" ], "variable": [ { "key": "euicc_id" }, { "key": "operation_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5072048c-1ae7-4256-b07c-d3a29d695c02" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1edd53f7-4090-4600-966b-158dc3c5cdcf" }, { "name": "Cancel operation", "id": "2daaacf8-68b1-4054-85e4-07b79831941d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation/:operation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation", ":operation_id" ], "variable": [ { "id": "d2dac967-3289-4611-b13d-e6366f74a6aa", "key": "euicc_id", "value": "", "description": "(Required) " }, { "id": "51be1dda-d6fb-499e-ab73-9a5d9f9ef763", "key": "operation_id", "value": "", "description": "(Required) " } ] }, "description": "Cancel a specific operation on specific IoT eUICC (reserved for future use).\n" }, "response": [ { "id": "2a7191e3-5676-418b-aa27-e4d8c19d10ac", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation/:operation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation", ":operation_id" ], "variable": [ { "key": "euicc_id" }, { "key": "operation_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2a7191e3-5676-418b-aa27-e4d8c19d10ac" }, { "id": "f3527d80-1cb5-451c-8501-1d79d5165b56", "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation/:operation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation", ":operation_id" ], "variable": [ { "key": "euicc_id" }, { "key": "operation_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f3527d80-1cb5-451c-8501-1d79d5165b56" }, { "id": "45ab982b-088f-4332-a1a1-9366da8ef3cc", "name": "Forbidden", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation/:operation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation", ":operation_id" ], "variable": [ { "key": "euicc_id" }, { "key": "operation_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-45ab982b-088f-4332-a1a1-9366da8ef3cc" }, { "id": "e0668db2-b191-43b8-9c93-551db53c5afc", "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation/:operation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation", ":operation_id" ], "variable": [ { "key": "euicc_id" }, { "key": "operation_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e0668db2-b191-43b8-9c93-551db53c5afc" }, { "id": "adbe7c7e-f43b-40d3-a57e-21a594b18f2b", "name": "Internal Server Error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation/:operation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation", ":operation_id" ], "variable": [ { "key": "euicc_id" }, { "key": "operation_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-adbe7c7e-f43b-40d3-a57e-21a594b18f2b" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2daaacf8-68b1-4054-85e4-07b79831941d" } ], "id": "7b9258c4-73b7-46c1-9268-3133834a2adc", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7b9258c4-73b7-46c1-9268-3133834a2adc" }, { "name": "List operation for eUICC", "id": "70f096a9-2360-4187-9429-968278a7a9d1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `action`\n- `status`\n- `iccid_with_luhn`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `action`\n- `status`\n- `iccid_with_luhn`\n- `creation_date`\n- `expiry_date`\n- `finalization_date`\n", "key": "sort", "value": "" } ], "variable": [ { "id": "67519cc8-90a8-414e-9f3f-68848ff58324", "key": "euicc_id", "value": "", "description": "(Required) " } ] }, "description": "List all operations of a specific IoT eUICC.\nThis route returns HTTP 404 error for non-IoT eUICCs.\n" }, "response": [ { "id": "dd8c813a-4bcf-4dde-986a-e5d9985fd2be", "name": "Operation list", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `action`\n- `status`\n- `iccid_with_luhn`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `action`\n- `status`\n- `iccid_with_luhn`\n- `creation_date`\n- `expiry_date`\n- `finalization_date`\n", "key": "sort", "value": "" } ], "variable": [ { "key": "euicc_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"action\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"creation_date\": \"\",\n \"last_updated_at\": \"\",\n \"user\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"expiry_date\": \"\",\n \"finalization_date\": \"\",\n \"error\": {\n \"reason\": \"\",\n \"message\": \"\"\n },\n \"iccid_with_luhn\": \"\"\n },\n {\n \"id\": \"\",\n \"action\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"creation_date\": \"\",\n \"last_updated_at\": \"\",\n \"user\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"expiry_date\": \"\",\n \"finalization_date\": \"\",\n \"error\": {\n \"reason\": \"\",\n \"message\": \"\"\n },\n \"iccid_with_luhn\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-dd8c813a-4bcf-4dde-986a-e5d9985fd2be" }, { "id": "26c65bb9-0f3d-4c2b-8908-c086f3ff4404", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `action`\n- `status`\n- `iccid_with_luhn`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `action`\n- `status`\n- `iccid_with_luhn`\n- `creation_date`\n- `expiry_date`\n- `finalization_date`\n", "key": "sort", "value": "" } ], "variable": [ { "key": "euicc_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-26c65bb9-0f3d-4c2b-8908-c086f3ff4404" }, { "id": "07b2d422-c8cc-44cf-9986-9e2ead0bcfeb", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `action`\n- `status`\n- `iccid_with_luhn`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `action`\n- `status`\n- `iccid_with_luhn`\n- `creation_date`\n- `expiry_date`\n- `finalization_date`\n", "key": "sort", "value": "" } ], "variable": [ { "key": "euicc_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-07b2d422-c8cc-44cf-9986-9e2ead0bcfeb" }, { "id": "57b54083-f56f-49d4-975e-6133daef76ec", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `action`\n- `status`\n- `iccid_with_luhn`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `action`\n- `status`\n- `iccid_with_luhn`\n- `creation_date`\n- `expiry_date`\n- `finalization_date`\n", "key": "sort", "value": "" } ], "variable": [ { "key": "euicc_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-57b54083-f56f-49d4-975e-6133daef76ec" }, { "id": "76d9566d-b3f0-4dee-89f9-8faa887a268b", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `action`\n- `status`\n- `iccid_with_luhn`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `action`\n- `status`\n- `iccid_with_luhn`\n- `creation_date`\n- `expiry_date`\n- `finalization_date`\n", "key": "sort", "value": "" } ], "variable": [ { "key": "euicc_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-76d9566d-b3f0-4dee-89f9-8faa887a268b" }, { "id": "0adadc42-1c40-4816-8794-2e7845919e80", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `action`\n- `status`\n- `iccid_with_luhn`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `action`\n- `status`\n- `iccid_with_luhn`\n- `creation_date`\n- `expiry_date`\n- `finalization_date`\n", "key": "sort", "value": "" } ], "variable": [ { "key": "euicc_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0adadc42-1c40-4816-8794-2e7845919e80" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-70f096a9-2360-4187-9429-968278a7a9d1" }, { "name": "Schedule eUICC operations", "id": "68afcb83-a60c-48cd-b686-177ec976d9e4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"action\": {\n \"id\": \"\"\n },\n \"validity_period\": 86400,\n \"iccid_with_luhn\": \"\",\n \"activation_code\": \"\",\n \"enable\": \"\",\n \"rollback\": \"\"\n },\n {\n \"action\": {\n \"id\": \"\"\n },\n \"validity_period\": 86400,\n \"iccid_with_luhn\": \"\",\n \"activation_code\": \"\",\n \"enable\": \"\",\n \"rollback\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation" ], "variable": [ { "id": "884146f4-b7a1-409a-b555-99e1a9b8d151", "key": "euicc_id", "value": "", "description": "(Required) " } ] }, "description": "Schedules one or more operations on the specified eUICC.\nEach array element represents a single operation request.\nThis route returns HTTP 404 error for non-IoT eUICCs.\n" }, "response": [ { "id": "ed075bca-f083-4104-9f9b-3e62acbae5c2", "name": "Created, operations scheduled", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"action\": {\n \"id\": \"\"\n },\n \"validity_period\": 86400,\n \"iccid_with_luhn\": \"\",\n \"activation_code\": \"\",\n \"enable\": \"\",\n \"rollback\": \"\"\n },\n {\n \"action\": {\n \"id\": \"\"\n },\n \"validity_period\": 86400,\n \"iccid_with_luhn\": \"\",\n \"activation_code\": \"\",\n \"enable\": \"\",\n \"rollback\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation" ], "variable": [ { "key": "euicc_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"action\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"creation_date\": \"\",\n \"last_updated_at\": \"\",\n \"user\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"expiry_date\": \"\",\n \"finalization_date\": \"\",\n \"error\": {\n \"reason\": \"\",\n \"message\": \"\"\n },\n \"iccid_with_luhn\": \"\"\n },\n {\n \"id\": \"\",\n \"action\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"creation_date\": \"\",\n \"last_updated_at\": \"\",\n \"user\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"expiry_date\": \"\",\n \"finalization_date\": \"\",\n \"error\": {\n \"reason\": \"\",\n \"message\": \"\"\n },\n \"iccid_with_luhn\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ed075bca-f083-4104-9f9b-3e62acbae5c2" }, { "id": "9dd12525-afe0-49ea-a622-fd0e8dddc7d0", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"action\": {\n \"id\": \"\"\n },\n \"validity_period\": 86400,\n \"iccid_with_luhn\": \"\",\n \"activation_code\": \"\",\n \"enable\": \"\",\n \"rollback\": \"\"\n },\n {\n \"action\": {\n \"id\": \"\"\n },\n \"validity_period\": 86400,\n \"iccid_with_luhn\": \"\",\n \"activation_code\": \"\",\n \"enable\": \"\",\n \"rollback\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation" ], "variable": [ { "key": "euicc_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9dd12525-afe0-49ea-a622-fd0e8dddc7d0" }, { "id": "ae9d10a5-4e17-4caf-be15-f675ecb3f413", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"action\": {\n \"id\": \"\"\n },\n \"validity_period\": 86400,\n \"iccid_with_luhn\": \"\",\n \"activation_code\": \"\",\n \"enable\": \"\",\n \"rollback\": \"\"\n },\n {\n \"action\": {\n \"id\": \"\"\n },\n \"validity_period\": 86400,\n \"iccid_with_luhn\": \"\",\n \"activation_code\": \"\",\n \"enable\": \"\",\n \"rollback\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation" ], "variable": [ { "key": "euicc_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ae9d10a5-4e17-4caf-be15-f675ecb3f413" }, { "id": "c4f9106e-9eb3-4080-9df7-d9c556b7fcde", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"action\": {\n \"id\": \"\"\n },\n \"validity_period\": 86400,\n \"iccid_with_luhn\": \"\",\n \"activation_code\": \"\",\n \"enable\": \"\",\n \"rollback\": \"\"\n },\n {\n \"action\": {\n \"id\": \"\"\n },\n \"validity_period\": 86400,\n \"iccid_with_luhn\": \"\",\n \"activation_code\": \"\",\n \"enable\": \"\",\n \"rollback\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation" ], "variable": [ { "key": "euicc_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c4f9106e-9eb3-4080-9df7-d9c556b7fcde" }, { "id": "dae40178-48f4-4c3f-8930-34d648a96070", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"action\": {\n \"id\": \"\"\n },\n \"validity_period\": 86400,\n \"iccid_with_luhn\": \"\",\n \"activation_code\": \"\",\n \"enable\": \"\",\n \"rollback\": \"\"\n },\n {\n \"action\": {\n \"id\": \"\"\n },\n \"validity_period\": 86400,\n \"iccid_with_luhn\": \"\",\n \"activation_code\": \"\",\n \"enable\": \"\",\n \"rollback\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation" ], "variable": [ { "key": "euicc_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-dae40178-48f4-4c3f-8930-34d648a96070" }, { "id": "de5c8e27-0f1a-4a33-a2b0-b13990fe127c", "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"action\": {\n \"id\": \"\"\n },\n \"validity_period\": 86400,\n \"iccid_with_luhn\": \"\",\n \"activation_code\": \"\",\n \"enable\": \"\",\n \"rollback\": \"\"\n },\n {\n \"action\": {\n \"id\": \"\"\n },\n \"validity_period\": 86400,\n \"iccid_with_luhn\": \"\",\n \"activation_code\": \"\",\n \"enable\": \"\",\n \"rollback\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id/operation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id", "operation" ], "variable": [ { "key": "euicc_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-de5c8e27-0f1a-4a33-a2b0-b13990fe127c" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-68afcb83-a60c-48cd-b686-177ec976d9e4" } ], "id": "de24266b-13a4-4432-8967-ce33a7e16dbb", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-de24266b-13a4-4432-8967-ce33a7e16dbb" }, { "name": "Get eUICC", "id": "212cde5c-f2fb-4d7b-a76c-44d6f570e408", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id" ], "variable": [ { "id": "78ac88bd-c4ce-4f2b-994d-f785007a9fd5", "key": "euicc_id", "value": "", "description": "(Required) " } ] }, "description": "List details on one specific eUICC within your organization.\n" }, "response": [ { "id": "74718812-39c6-4fb6-9cbf-6adc9983e37f", "name": "eUICC detail", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id" ], "variable": [ { "key": "euicc_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"eid\": \"\",\n \"created\": \"\",\n \"profile\": [\n {\n \"iccid_with_luhn\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"customer_org\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"operator\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"preloaded\": \"\",\n \"fallback_allowed\": \"\",\n \"fallback_attribute\": \"\",\n \"profile_type\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"endpoint\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"iccid_with_luhn\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"customer_org\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"operator\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"preloaded\": \"\",\n \"fallback_allowed\": \"\",\n \"fallback_attribute\": \"\",\n \"profile_type\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"endpoint\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"issuer_org\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"customer_org\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"supported_profile_type\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"last_audited\": \"\",\n \"last_polled\": \"\",\n \"last_synced\": \"\",\n \"eim\": {\n \"id\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-74718812-39c6-4fb6-9cbf-6adc9983e37f" }, { "id": "4a6378d9-c2f0-4aee-abc6-fdf81bf2e1af", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id" ], "variable": [ { "key": "euicc_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-4a6378d9-c2f0-4aee-abc6-fdf81bf2e1af" }, { "id": "99145b15-a2f4-4d14-9071-85beb10b1687", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id" ], "variable": [ { "key": "euicc_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-99145b15-a2f4-4d14-9071-85beb10b1687" }, { "id": "039c1d28-a7a7-49c4-9366-f8e653f88e4a", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id" ], "variable": [ { "key": "euicc_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-039c1d28-a7a7-49c4-9366-f8e653f88e4a" }, { "id": "f4cd27f6-65ab-4fc3-b54f-309038816364", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc/:euicc_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc", ":euicc_id" ], "variable": [ { "key": "euicc_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f4cd27f6-65ab-4fc3-b54f-309038816364" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-212cde5c-f2fb-4d7b-a76c-44d6f570e408" } ], "id": "0c36fb0c-3c3a-4459-b756-bece88d7344d", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0c36fb0c-3c3a-4459-b756-bece88d7344d" }, { "name": "List eUICCs", "id": "958b6505-3c08-49e2-ae9a-421d2b7a85ed", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `eid`\n- `supported_profile_type`\n- `status`\n- `eim`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `eid`\n- `modified`\n- `supported_profile_type`\n- `status`\n- `eim`\n", "key": "sort", "value": "" } ] }, "description": "List all eUICCs for your organization.\nUse filter parameters to search for specific eUICCs and sort to order the response list.\n" }, "response": [ { "id": "3d794b8a-bb39-4cee-b185-6e63d9ea02bc", "name": "List of eUICCs", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `eid`\n- `supported_profile_type`\n- `status`\n- `eim`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `eid`\n- `modified`\n- `supported_profile_type`\n- `status`\n- `eim`\n", "key": "sort", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"eid\": \"\",\n \"created\": \"\",\n \"profile\": [\n {\n \"iccid_with_luhn\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"customer_org\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"operator\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"preloaded\": \"\",\n \"fallback_allowed\": \"\",\n \"fallback_attribute\": \"\",\n \"profile_type\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"endpoint\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"iccid_with_luhn\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"customer_org\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"operator\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"preloaded\": \"\",\n \"fallback_allowed\": \"\",\n \"fallback_attribute\": \"\",\n \"profile_type\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"endpoint\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"issuer_org\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"customer_org\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"supported_profile_type\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"last_audited\": \"\",\n \"last_polled\": \"\",\n \"last_synced\": \"\",\n \"eim\": {\n \"id\": \"\",\n \"description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"eid\": \"\",\n \"created\": \"\",\n \"profile\": [\n {\n \"iccid_with_luhn\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"customer_org\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"operator\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"preloaded\": \"\",\n \"fallback_allowed\": \"\",\n \"fallback_attribute\": \"\",\n \"profile_type\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"endpoint\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"iccid_with_luhn\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"customer_org\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"operator\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"preloaded\": \"\",\n \"fallback_allowed\": \"\",\n \"fallback_attribute\": \"\",\n \"profile_type\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"endpoint\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"issuer_org\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"customer_org\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"supported_profile_type\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"last_audited\": \"\",\n \"last_polled\": \"\",\n \"last_synced\": \"\",\n \"eim\": {\n \"id\": \"\",\n \"description\": \"\"\n }\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3d794b8a-bb39-4cee-b185-6e63d9ea02bc" }, { "id": "bf4afe99-1330-4c16-9856-17518d876020", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `eid`\n- `supported_profile_type`\n- `status`\n- `eim`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `eid`\n- `modified`\n- `supported_profile_type`\n- `status`\n- `eim`\n", "key": "sort", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-bf4afe99-1330-4c16-9856-17518d876020" }, { "id": "5d67834b-c94a-45cd-84df-282256601f26", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `eid`\n- `supported_profile_type`\n- `status`\n- `eim`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `eid`\n- `modified`\n- `supported_profile_type`\n- `status`\n- `eim`\n", "key": "sort", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5d67834b-c94a-45cd-84df-282256601f26" }, { "id": "07ee9f98-a401-4d91-8255-14dc440ce526", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `eid`\n- `supported_profile_type`\n- `status`\n- `eim`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `eid`\n- `modified`\n- `supported_profile_type`\n- `status`\n- `eim`\n", "key": "sort", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-07ee9f98-a401-4d91-8255-14dc440ce526" }, { "id": "721456b4-0a07-4dff-803d-c4967597553c", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `eid`\n- `supported_profile_type`\n- `status`\n- `eim`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `eid`\n- `modified`\n- `supported_profile_type`\n- `status`\n- `eim`\n", "key": "sort", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-721456b4-0a07-4dff-803d-c4967597553c" }, { "id": "87e7879c-4fca-4b43-9aa6-d9f77752b127", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/euicc?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "euicc" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `eid`\n- `supported_profile_type`\n- `status`\n- `eim`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `eid`\n- `modified`\n- `supported_profile_type`\n- `status`\n- `eim`\n", "key": "sort", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-87e7879c-4fca-4b43-9aa6-d9f77752b127" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-958b6505-3c08-49e2-ae9a-421d2b7a85ed" } ], "id": "19322d0a-45d1-4112-8390-248e47e63c12", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-19322d0a-45d1-4112-8390-248e47e63c12" }, { "name": "event", "item": [ { "name": "custom", "item": [ { "name": "configuration", "item": [ { "name": "{custom_event_id}", "item": [ { "name": "Get a custom event by ID", "id": "fda72463-b950-4ac3-845d-e5120f1f0053", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/event/custom/configuration/:custom_event_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event", "custom", "configuration", ":custom_event_id" ], "variable": [ { "id": "00c7ff4b-93e0-40d4-9236-fe57ba9b8560", "key": "custom_event_id", "value": "", "description": "(Required) " } ] }, "description": "Retrieves a specific custom event and its supported targeting options.\n" }, "response": [ { "id": "ddd7b295-96a9-4ba3-abf2-4ca2bec67e7f", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/event/custom/configuration/:custom_event_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event", "custom", "configuration", ":custom_event_id" ], "variable": [ { "key": "custom_event_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"organisation\": {\n \"id\": \"\"\n },\n \"template\": {\n \"id\": \"\"\n },\n \"configuration_properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"name\": \"\",\n \"id\": \"\",\n \"supportedTargetingParameters\": [\n \"\",\n \"\"\n ],\n \"supportedActions\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ddd7b295-96a9-4ba3-abf2-4ca2bec67e7f" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-fda72463-b950-4ac3-845d-e5120f1f0053" }, { "name": "Delete custom event", "id": "13c4a0f6-b0cb-45e0-8366-bfff008ea72c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/event/custom/configuration/:custom_event_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event", "custom", "configuration", ":custom_event_id" ], "variable": [ { "id": "ce0a6869-511d-4f0b-aa85-61015578f68c", "key": "custom_event_id", "value": "", "description": "(Required) " } ] }, "description": "Deletes a custom event with the specified configuration.\n" }, "response": [ { "id": "1a5a8bb9-831b-436b-94fe-7cc34f9a37e0", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/event/custom/configuration/:custom_event_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event", "custom", "configuration", ":custom_event_id" ], "variable": [ { "key": "custom_event_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1a5a8bb9-831b-436b-94fe-7cc34f9a37e0" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-13c4a0f6-b0cb-45e0-8366-bfff008ea72c" } ], "id": "a355af36-f95e-49a7-ad18-1e4af6f35044", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a355af36-f95e-49a7-ad18-1e4af6f35044" }, { "name": "List custom events", "id": "214e6f0a-ea61-42d8-9767-f6bf4d655644", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/event/custom/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event", "custom", "configuration" ] }, "description": "Returns a list of all available custom events and their supported targeting options.\n" }, "response": [ { "id": "02661196-83fe-4d53-9105-24e2a03d7765", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/event/custom/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event", "custom", "configuration" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"organisation\": {\n \"id\": \"\"\n },\n \"template\": {\n \"id\": \"\"\n },\n \"configuration_properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"name\": \"\",\n \"id\": \"\",\n \"supportedTargetingParameters\": [\n \"\",\n \"\"\n ],\n \"supportedActions\": [\n \"\",\n \"\"\n ]\n },\n {\n \"organisation\": {\n \"id\": \"\"\n },\n \"template\": {\n \"id\": \"\"\n },\n \"configuration_properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"name\": \"\",\n \"id\": \"\",\n \"supportedTargetingParameters\": [\n \"\",\n \"\"\n ],\n \"supportedActions\": [\n \"\",\n \"\"\n ]\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-02661196-83fe-4d53-9105-24e2a03d7765" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-214e6f0a-ea61-42d8-9767-f6bf4d655644" }, { "name": "Deploy custom event", "id": "35bd44ad-ac5a-4a8d-8510-0e8d462bc1a6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"organisation\": {\n \"id\": \"\"\n },\n \"template\": {\n \"id\": \"\"\n },\n \"configuration_properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/event/custom/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event", "custom", "configuration" ] }, "description": "Deploys a custom event with the specified configuration.\n" }, "response": [ { "id": "2ae65e96-b77d-4fa9-8463-42146096b200", "name": "response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"organisation\": {\n \"id\": \"\"\n },\n \"template\": {\n \"id\": \"\"\n },\n \"configuration_properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/event/custom/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event", "custom", "configuration" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"organisation\": {\n \"id\": \"\"\n },\n \"template\": {\n \"id\": \"\"\n },\n \"configuration_properties\": [\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n },\n {\n \"property\": \"\",\n \"value\": \"\",\n \"value_array\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"name\": \"\",\n \"id\": \"\",\n \"supportedTargetingParameters\": [\n \"\",\n \"\"\n ],\n \"supportedActions\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2ae65e96-b77d-4fa9-8463-42146096b200" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-35bd44ad-ac5a-4a8d-8510-0e8d462bc1a6" } ], "id": "546e0c5e-e560-4d1e-abd2-30adff86cf8f", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-546e0c5e-e560-4d1e-abd2-30adff86cf8f" }, { "name": "template", "item": [ { "name": "{template_id}", "item": [ { "name": "Get a custom event template by ID", "id": "ed9a7772-ab18-464d-8544-c764e6fd83ea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/event/custom/template/:template_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event", "custom", "template", ":template_id" ], "variable": [ { "id": "807c7de0-dec1-4679-a273-5331fa336c48", "key": "template_id", "value": "", "description": "(Required) " } ] }, "description": "Retrieves a specific custom event template and its possible configuration parameters.\n" }, "response": [ { "id": "8e2c0cd0-c47c-46d5-852b-c91ba1addd70", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/event/custom/template/:template_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event", "custom", "template", ":template_id" ], "variable": [ { "key": "template_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"parent_organisation\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"translationKeyName\": \"\",\n \"status\": \"\",\n \"description\": \"\",\n \"translationKeyDescription\": \"\",\n \"configuration_properties\": [\n {\n \"property\": \"\",\n \"type\": \"\",\n \"default\": \"\",\n \"required\": \"\",\n \"description\": \"\",\n \"validators\": [\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n },\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n }\n ]\n },\n {\n \"property\": \"\",\n \"type\": \"\",\n \"default\": \"\",\n \"required\": \"\",\n \"description\": \"\",\n \"validators\": [\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n },\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n }\n ]\n }\n ],\n \"supported_targeting_parameters\": [\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"validators\": [\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n },\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n }\n ]\n },\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"validators\": [\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n },\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n }\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8e2c0cd0-c47c-46d5-852b-c91ba1addd70" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ed9a7772-ab18-464d-8544-c764e6fd83ea" } ], "id": "cf4d9a66-3b7e-42f3-97d5-8e4c38de8e7e", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cf4d9a66-3b7e-42f3-97d5-8e4c38de8e7e" }, { "name": "List custom event templates", "id": "9e58f388-faf0-4d63-8158-b76c78ec6bb2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/event/custom/template", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event", "custom", "template" ] }, "description": "Returns a list of all available custom event templates and their possible configuration parameters.\n" }, "response": [ { "id": "2d97006a-8f34-45de-b371-8ca16d17452c", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/event/custom/template", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event", "custom", "template" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"parent_organisation\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"translationKeyName\": \"\",\n \"status\": \"\",\n \"description\": \"\",\n \"translationKeyDescription\": \"\",\n \"configuration_properties\": [\n {\n \"property\": \"\",\n \"type\": \"\",\n \"default\": \"\",\n \"required\": \"\",\n \"description\": \"\",\n \"validators\": [\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n },\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n }\n ]\n },\n {\n \"property\": \"\",\n \"type\": \"\",\n \"default\": \"\",\n \"required\": \"\",\n \"description\": \"\",\n \"validators\": [\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n },\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n }\n ]\n }\n ],\n \"supported_targeting_parameters\": [\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"validators\": [\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n },\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n }\n ]\n },\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"validators\": [\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n },\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"id\": \"\",\n \"parent_organisation\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"translationKeyName\": \"\",\n \"status\": \"\",\n \"description\": \"\",\n \"translationKeyDescription\": \"\",\n \"configuration_properties\": [\n {\n \"property\": \"\",\n \"type\": \"\",\n \"default\": \"\",\n \"required\": \"\",\n \"description\": \"\",\n \"validators\": [\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n },\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n }\n ]\n },\n {\n \"property\": \"\",\n \"type\": \"\",\n \"default\": \"\",\n \"required\": \"\",\n \"description\": \"\",\n \"validators\": [\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n },\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n }\n ]\n }\n ],\n \"supported_targeting_parameters\": [\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"validators\": [\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n },\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n }\n ]\n },\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"validators\": [\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n },\n {\n \"validator_type\": \"\",\n \"validator_value\": \"\"\n }\n ]\n }\n ]\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2d97006a-8f34-45de-b371-8ca16d17452c" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9e58f388-faf0-4d63-8158-b76c78ec6bb2" } ], "id": "ac627364-83a8-462d-bf89-bd592d71c195", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ac627364-83a8-462d-bf89-bd592d71c195" } ], "id": "a2f874b7-b3b0-4ff5-96ba-83a681097968", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a2f874b7-b3b0-4ff5-96ba-83a681097968" }, { "name": "system", "item": [ { "name": "configuration", "item": [ { "name": "{system_event_id}", "item": [ { "name": "Get a system event by ID", "id": "2deb1d41-0e34-4722-b249-ed291a294b44", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/event/system/configuration/:system_event_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event", "system", "configuration", ":system_event_id" ], "variable": [ { "id": "28380afa-89ce-4aed-a621-5e22ecd8bf24", "key": "system_event_id", "value": "", "description": "(Required) " } ] }, "description": "Retrieves a specific system event and its supported targeting options.\n" }, "response": [ { "id": "0d7f0b1a-7a06-48aa-9a9d-9665b5d00e76", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/event/system/configuration/:system_event_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event", "system", "configuration", ":system_event_id" ], "variable": [ { "key": "system_event_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"parentOrg\": {\n \"id\": \"\"\n },\n \"eventType\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"translationKeyName\": \"\",\n \"description\": \"\",\n \"translationKeyDescription\": \"\",\n \"supportedTargetingParameters\": [\n \"\",\n \"\"\n ],\n \"eventOutputParameters\": [\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"supportedActions\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0d7f0b1a-7a06-48aa-9a9d-9665b5d00e76" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2deb1d41-0e34-4722-b249-ed291a294b44" } ], "id": "d2a40296-b70f-4179-9fc4-b7475024b3c1", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d2a40296-b70f-4179-9fc4-b7475024b3c1" }, { "name": "List system events", "id": "d1cce0ca-10c4-4794-a8f1-3bda30f60c38", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/event/system/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event", "system", "configuration" ] }, "description": "Returns a list of all available system events and their supported targeting options.\n" }, "response": [ { "id": "0ebd8bee-f98a-4a1c-b88f-b20cd6189103", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/event/system/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event", "system", "configuration" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"parentOrg\": {\n \"id\": \"\"\n },\n \"eventType\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"translationKeyName\": \"\",\n \"description\": \"\",\n \"translationKeyDescription\": \"\",\n \"supportedTargetingParameters\": [\n \"\",\n \"\"\n ],\n \"eventOutputParameters\": [\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"supportedActions\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"parentOrg\": {\n \"id\": \"\"\n },\n \"eventType\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"translationKeyName\": \"\",\n \"description\": \"\",\n \"translationKeyDescription\": \"\",\n \"supportedTargetingParameters\": [\n \"\",\n \"\"\n ],\n \"eventOutputParameters\": [\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n {\n \"parameter\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"supportedActions\": [\n \"\",\n \"\"\n ]\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0ebd8bee-f98a-4a1c-b88f-b20cd6189103" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d1cce0ca-10c4-4794-a8f1-3bda30f60c38" } ], "id": "f42cb228-1338-4386-9d5e-7048e2cc074e", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f42cb228-1338-4386-9d5e-7048e2cc074e" } ], "id": "5d8f1128-6596-49bd-b38e-59379f16a284", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5d8f1128-6596-49bd-b38e-59379f16a284" }, { "name": "type", "item": [ { "name": "List event types", "id": "8d7154bc-c6f4-40d1-bddc-94b84e83e914", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/event/type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event", "type" ] }, "description": "Provides the list of event_types (lookup)." }, "response": [ { "id": "4822d774-3019-4c11-8f91-12bb196ab15d", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/event/type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event", "type" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-4822d774-3019-4c11-8f91-12bb196ab15d" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8d7154bc-c6f4-40d1-bddc-94b84e83e914" } ], "id": "72024d7a-7a70-4b87-b38d-4eef9417008c", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-72024d7a-7a70-4b87-b38d-4eef9417008c" }, { "name": "List events", "id": "b96ccac1-8f08-46e0-a687-2e19902f2257", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/event?page=&per_page=&sort=&q=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event" ], "query": [ { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "per_page", "value": "" }, { "description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n", "key": "sort", "value": "" }, { "description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n", "key": "q", "value": "" } ] }, "description": "Returns the list of events, filtered, sorted and paged according to query parameters." }, "response": [ { "id": "683eb06c-0d47-4968-bee8-ab820aff83e1", "name": "Successfully returned a list of events", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/event?page=&per_page=&sort=&q=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event" ], "query": [ { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "per_page", "value": "" }, { "description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n", "key": "sort", "value": "" }, { "description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n", "key": "q", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"alert\": \"\",\n \"description\": \"\",\n \"timestamp\": \"\",\n \"event_type\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"event_source\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"event_severity\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"organisation\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"user\": {\n \"id\": \"\",\n \"username\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"alert\": \"\",\n \"description\": \"\",\n \"timestamp\": \"\",\n \"event_type\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"event_source\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"event_severity\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"organisation\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"user\": {\n \"id\": \"\",\n \"username\": \"\",\n \"name\": \"\"\n }\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-683eb06c-0d47-4968-bee8-ab820aff83e1" }, { "id": "eb42e443-f113-4afd-a3f4-3ae0701f5a07", "name": "**Bad Request** due to incorrect **Paging** Parameters or **Sorting** Parameter\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/event?page=&per_page=&sort=&q=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event" ], "query": [ { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "per_page", "value": "" }, { "description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n", "key": "sort", "value": "" }, { "description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n", "key": "q", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-eb42e443-f113-4afd-a3f4-3ae0701f5a07" }, { "id": "ba6e094b-afe2-4b43-a621-bcdf6307a80f", "name": "**Unprocessable Entity** due to incorrect **Query** parameters\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/event?page=&per_page=&sort=&q=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "event" ], "query": [ { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "per_page", "value": "" }, { "description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n", "key": "sort", "value": "" }, { "description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n", "key": "q", "value": "" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ba6e094b-afe2-4b43-a621-bcdf6307a80f" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b96ccac1-8f08-46e0-a687-2e19902f2257" } ], "id": "fd8677ab-1d17-4d61-b6b0-3021fc9d325b", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-fd8677ab-1d17-4d61-b6b0-3021fc9d325b" }, { "name": "ip_address_space", "item": [ { "name": "available", "item": [ { "name": "Get random address spaces", "id": "d5345cee-3a43-489a-bf8d-f738645bd8d3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/ip_address_space/available?ip_address_version=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ip_address_space", "available" ], "query": [ { "description": "Filter by IPv4 which is default or by IPv6.\nExample: `ip_address_version=4` or `ip_address_version=6`\n", "key": "ip_address_version", "value": "" } ] }, "description": "Provides a list of 10 random available address spaces (unassigned to any organization).\nAs the list is generated for each request, two successive requests will have different results.\n" }, "response": [ { "id": "98ea5357-4666-4c2b-8513-26ca689725fe", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/ip_address_space/available?ip_address_version=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ip_address_space", "available" ], "query": [ { "description": "Filter by IPv4 which is default or by IPv6.\nExample: `ip_address_version=4` or `ip_address_version=6`\n", "key": "ip_address_version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"ip_address_space\": \"\",\n \"ip_address_version\": \"\"\n },\n {\n \"id\": \"\",\n \"ip_address_space\": \"\",\n \"ip_address_version\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-98ea5357-4666-4c2b-8513-26ca689725fe" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d5345cee-3a43-489a-bf8d-f738645bd8d3" } ], "id": "bbf64c33-b2c4-4aab-ae99-f6f395146b68", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-bbf64c33-b2c4-4aab-ae99-f6f395146b68" }, { "name": "{address_space_id}", "item": [ { "name": "Assign an IP address space to an organization", "id": "55c61e41-9fa4-4728-a2e3-7e11020bd1b3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/ip_address_space/:address_space_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ip_address_space", ":address_space_id" ], "variable": [ { "id": "137c9bea-9f8b-4e87-8b35-d63fbdc359af", "key": "address_space_id", "value": "", "description": "(Required) " } ] }, "description": "\n Use POST API call instead of this deprecated PUT command.\n\n\nThe IP address space is assigned to the user's organization.\n" }, "response": [ { "id": "4a598ce4-9ed5-4f5f-8bee-d52d07552f77", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/ip_address_space/:address_space_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ip_address_space", ":address_space_id" ], "variable": [ { "key": "address_space_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-4a598ce4-9ed5-4f5f-8bee-d52d07552f77" }, { "id": "a663dde5-1582-42c9-8d81-5e84d1efb87d", "name": "Unexpected error in API call. See HTTP response body for details.", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/ip_address_space/:address_space_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ip_address_space", ":address_space_id" ], "variable": [ { "key": "address_space_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a663dde5-1582-42c9-8d81-5e84d1efb87d" }, { "id": "f989c16d-a68d-420c-b113-38b33afbb92a", "name": "Unexpected error in API call. See HTTP response body for details.", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/ip_address_space/:address_space_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ip_address_space", ":address_space_id" ], "variable": [ { "key": "address_space_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f989c16d-a68d-420c-b113-38b33afbb92a" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-55c61e41-9fa4-4728-a2e3-7e11020bd1b3" }, { "name": "Release an IP address space from an organization", "id": "6d06a51c-5083-4cb0-b3ed-092e08f55775", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/ip_address_space/:address_space_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ip_address_space", ":address_space_id" ], "variable": [ { "id": "98030927-4845-402b-8878-fa980d43ce4b", "key": "address_space_id", "value": "", "description": "(Required) " } ] }, "description": "Release the IP address space from association with the user's organisation.\n\n\n IP address spaces can only be removed, if the IP address space isn't used on any of the organisations endpoints.\n\n" }, "response": [ { "id": "3cf6a6be-1fa6-4095-b1b0-789e0d93e077", "name": "Response to a successful request that is not returning a body", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/ip_address_space/:address_space_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ip_address_space", ":address_space_id" ], "variable": [ { "key": "address_space_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3cf6a6be-1fa6-4095-b1b0-789e0d93e077" }, { "id": "3f967642-49b8-4f17-ada5-26468605b5e7", "name": "Unexpected error in API call. See HTTP response body for details.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/ip_address_space/:address_space_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ip_address_space", ":address_space_id" ], "variable": [ { "key": "address_space_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3f967642-49b8-4f17-ada5-26468605b5e7" }, { "id": "8db50981-13b6-4d29-99e7-ed4ce301dd61", "name": "Unexpected error in API call. See HTTP response body for details.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/ip_address_space/:address_space_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ip_address_space", ":address_space_id" ], "variable": [ { "key": "address_space_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8db50981-13b6-4d29-99e7-ed4ce301dd61" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6d06a51c-5083-4cb0-b3ed-092e08f55775" } ], "id": "f6f4e3b0-c13b-482e-9994-a19d6f4242cf", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f6f4e3b0-c13b-482e-9994-a19d6f4242cf" }, { "name": "List IP address spaces", "id": "5b37f890-79ec-4b8a-ab52-2e97150a1000", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/ip_address_space", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ip_address_space" ] }, "description": "Returns a list of allocated IP address spaces for your organization." }, "response": [ { "id": "e64180f1-98ed-4b7f-8955-7c45b4d09137", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/ip_address_space", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ip_address_space" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"ip_address_space\": \"\",\n \"ip_address_version\": \"\",\n \"used_count\": \"\",\n \"available_count\": \"\"\n },\n {\n \"id\": \"\",\n \"ip_address_space\": \"\",\n \"ip_address_version\": \"\",\n \"used_count\": \"\",\n \"available_count\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e64180f1-98ed-4b7f-8955-7c45b4d09137" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5b37f890-79ec-4b8a-ab52-2e97150a1000" }, { "name": "Create an IP address space", "id": "173484d1-902d-42fe-a2e0-7b86080a703c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ip_address_space\": \"\",\n \"ip_address_version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/ip_address_space", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ip_address_space" ] }, "description": "Checks the requested IP address space for validity and availability, then allocates it to your organization.\n" }, "response": [ { "id": "2ba3a603-b05e-4043-9e94-1236c98029d6", "name": "Created\n\nThe requested IP address space is created.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"ip_address_space\": \"\",\n \"ip_address_version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/ip_address_space", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ip_address_space" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"ip_address_space\": \"\",\n \"ip_address_version\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2ba3a603-b05e-4043-9e94-1236c98029d6" }, { "id": "a1b3cb95-16a1-4b4b-a710-2632e6d75d42", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"ip_address_space\": \"\",\n \"ip_address_version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/ip_address_space", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ip_address_space" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_token\": \"\",\n \"message\": \"\",\n \"error_code\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a1b3cb95-16a1-4b4b-a710-2632e6d75d42" }, { "id": "cc6401a2-43e0-402f-a10d-d011cede80fa", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"ip_address_space\": \"\",\n \"ip_address_version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/ip_address_space", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ip_address_space" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_token\": \"\",\n \"message\": \"\",\n \"error_code\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cc6401a2-43e0-402f-a10d-d011cede80fa" }, { "id": "98a1fd1a-9fe4-47d7-8eb0-308be092dad3", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"ip_address_space\": \"\",\n \"ip_address_version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/ip_address_space", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ip_address_space" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_token\": \"\",\n \"message\": \"\",\n \"error_code\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-98a1fd1a-9fe4-47d7-8eb0-308be092dad3" }, { "id": "67b40972-e409-40ec-af07-b78d2c25a305", "name": "The requested IP address space overlaps with an existing allocated IP address space.\n\nFor example, `10.176.0.0/12` and `10.176.0.0/24` or `10.188.33.16/28`.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"ip_address_space\": \"\",\n \"ip_address_version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/ip_address_space", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ip_address_space" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_token\": \"\",\n \"message\": \"\",\n \"error_code\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-67b40972-e409-40ec-af07-b78d2c25a305" }, { "id": "f72cbec3-9cac-49d5-8373-97b9cad227a2", "name": "Your requested IP address space isn't allowed or overlaps with a reserved range.\n\n\n These responses have different root causes but share an [error code](/developers/api-guidelines/errors#list-of-error-codes) and token.\n Be sure to check the err", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"ip_address_space\": \"\",\n \"ip_address_version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/ip_address_space", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ip_address_space" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_token\": \"\",\n \"message\": \"\",\n \"error_code\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f72cbec3-9cac-49d5-8373-97b9cad227a2" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-173484d1-902d-42fe-a2e0-7b86080a703c" } ], "id": "920327ff-8134-49a1-8c98-87dc71c6b2a4", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-920327ff-8134-49a1-8c98-87dc71c6b2a4" }, { "name": "operator", "item": [ { "name": "List operators", "id": "f8022574-8c38-476f-b1e1-c5efaf2990a8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/operator", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "operator" ] }, "description": "Returns a collection of existing operators.\n\nIt will return an array of items with following properties:\n\n* `id`: identifier of this operator\n* `name`: the official name of the operator\n* `name_and_country`: Name / Country (for easy access in the UI)\n* `country`: country object with the nested country `id`\n* `mnc`: Array of Mobile Network Codes (MNCs)\n* `tapcode`: Array of TAP Codes\n" }, "response": [ { "id": "ea963cd8-f5aa-4cfc-b1db-685f914018d9", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/operator", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "operator" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"name\": \"\",\n \"country_name\": \"\",\n \"id\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"mcc\": \"\",\n \"iso_code\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"country_name\": \"\",\n \"id\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"mcc\": \"\",\n \"iso_code\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ea963cd8-f5aa-4cfc-b1db-685f914018d9" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f8022574-8c38-476f-b1e1-c5efaf2990a8" } ], "id": "01a42f38-6aee-4a1c-b9d9-63848eab2cc9", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-01a42f38-6aee-4a1c-b9d9-63848eab2cc9" }, { "name": "organisation", "item": [ { "name": "my", "item": [ { "name": "My organization details", "id": "998054b0-1461-4de3-b6bb-f0d9a996b150", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/organisation/my", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", "my" ] }, "description": "You can retrieve details about your own organisation" }, "response": [ { "id": "d74a8320-2602-4131-befe-ab24b4873e97", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/organisation/my", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", "my" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"organisation_type_id\": \"\",\n \"country_id\": \"\",\n \"organisation_status_id\": \"\",\n \"ext_reference\": \"\",\n \"monthly_cost_limit\": \"\",\n \"currency_id\": \"\",\n \"organisation_class_id\": \"\",\n \"created\": \"\",\n \"verification_type_id\": \"\",\n \"verification\": \"\",\n \"brand_id\": \"\",\n \"default_sms_routing_id\": \"\",\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d74a8320-2602-4131-befe-ab24b4873e97" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-998054b0-1461-4de3-b6bb-f0d9a996b150" } ], "id": "5b284d8c-cb49-4ba5-8be3-3d4c70f66dc9", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5b284d8c-cb49-4ba5-8be3-3d4c70f66dc9" }, { "name": "status", "item": [ { "name": "List organization statuses", "id": "a357b521-0969-4e5f-93c5-0dcd52da79e3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/organisation/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", "status" ] }, "description": "Provides a list of available organisation status (lookup)." }, "response": [ { "id": "270aba29-b6b6-4fdc-9d2a-dcffc16f63a2", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/organisation/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-270aba29-b6b6-4fdc-9d2a-dcffc16f63a2" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a357b521-0969-4e5f-93c5-0dcd52da79e3" } ], "id": "f1f4e97f-8523-4bbb-ba0f-0fc7ac05dedc", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f1f4e97f-8523-4bbb-ba0f-0fc7ac05dedc" }, { "name": "{org_id_or_my}", "item": [ { "name": "inclusive_volume", "item": [ { "name": "active", "item": [ { "name": "Get list of active organization inclusive volumes", "id": "9f057612-928d-425d-b124-b4fe9763421f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id_or_my/inclusive_volume/active", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id_or_my", "inclusive_volume", "active" ], "variable": [ { "id": "72d77103-f79a-431f-898a-7fd8963df9ec", "key": "org_id_or_my", "value": "my", "description": "(Required) Numerical ID of an Organization or the string `my` to use the currently authorized organisation" } ] }, "description": "Returns of a list of inclusive volumes that are currently active in the current billing period for the selected organisation.\nThis will not inclusive volumes that are already expired or have the start date set for a future billing period.\n\nOnly inclusive volumes for the own organisation or direct child organisations are accessible.\n" }, "response": [ { "id": "e2b56a77-65ed-46d2-b258-242f13d80a9f", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id_or_my/inclusive_volume/active", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id_or_my", "inclusive_volume", "active" ], "variable": [ { "key": "org_id_or_my" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"volume\": \"\",\n \"rate\": \"\",\n \"pooled\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"currency\": {\n \"id\": \"\",\n \"code\": \"\",\n \"symbol\": \"\"\n },\n \"tariff\": {\n \"id\": \"\",\n \"name\": \"\",\n \"tariff_status_id\": \"\",\n \"ratezone\": {\n \"id\": \"\",\n \"name\": \"\",\n \"ratezone_status_id\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"volume\": \"\",\n \"rate\": \"\",\n \"pooled\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"currency\": {\n \"id\": \"\",\n \"code\": \"\",\n \"symbol\": \"\"\n },\n \"tariff\": {\n \"id\": \"\",\n \"name\": \"\",\n \"tariff_status_id\": \"\",\n \"ratezone\": {\n \"id\": \"\",\n \"name\": \"\",\n \"ratezone_status_id\": \"\"\n }\n }\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e2b56a77-65ed-46d2-b258-242f13d80a9f" }, { "id": "3bafb29d-25e7-4c87-abed-43497658705a", "name": "A non-existent resource is requested", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id_or_my/inclusive_volume/active", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id_or_my", "inclusive_volume", "active" ], "variable": [ { "key": "org_id_or_my" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3bafb29d-25e7-4c87-abed-43497658705a" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9f057612-928d-425d-b124-b4fe9763421f" } ], "id": "ecdd9b05-6554-4d81-a939-a1d103c1585e", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ecdd9b05-6554-4d81-a939-a1d103c1585e" }, { "name": "{inclusive_volume_id}", "item": [ { "name": "Assign a ratezone inclusive volume to an organization", "id": "a43550fb-3038-4599-a6ca-00e9e31076a6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"pooled\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id_or_my/inclusive_volume/:inclusive_volume_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id_or_my", "inclusive_volume", ":inclusive_volume_id" ], "variable": [ { "id": "e06f5679-f4ed-4e0a-afec-724fbb7f89b1", "key": "org_id_or_my", "value": "my", "description": "(Required) Numerical ID of an Organization or the string `my` to use the currently authorized organisation" }, { "id": "d20d4301-2a92-4d90-8d99-20d200f954b7", "key": "inclusive_volume_id", "value": "", "description": "(Required) Numerical ID of a ratezone inclusive volume.\nCan be retrieved using `GET /api/v1/tariff/{tariff_id}/ratezone/{ratezone_id}/inclusive_volume`.\n" } ] }, "description": "Assigns a pre-configured ratezone inclusive volume to the specified organization.\n\nThis can be done in self-service as well as for direct child organizations.\nOnly postpaid customers can assign\ninclusive volumes in self-service, while parent organizations can assign inclusive volumes for both postpaid and prepaid child organizations.\nThe inclusive volume is charged and calculated against traffic charges accordingly in every bill\nthat is refreshed from that point on.\nInclusive volume is counted per device on a monthly basis, the data can be pooled as well or be treated per individual device.\n\nOnly inclusive volumes of ratezones belonging to the tariffs assigned to the selected organization can be chosen.\n\nEnterprise organizations are only allowed to upgrade to a higher inclusive volume if there is already one active in the current month.\n\nThe request body is optional. All fields have default values and detailed constraints are specified in the schema below.\n" }, "response": [ { "id": "1195a259-f380-40cf-ba23-4c14b497d48b", "name": "Created", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"pooled\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id_or_my/inclusive_volume/:inclusive_volume_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id_or_my", "inclusive_volume", ":inclusive_volume_id" ], "variable": [ { "key": "org_id_or_my" }, { "key": "inclusive_volume_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"pooled\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1195a259-f380-40cf-ba23-4c14b497d48b" }, { "id": "a805d938-9ec0-411b-9189-e5e85daa0b1a", "name": "The request is malformed, e.g. the body cannot be parsed", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"pooled\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id_or_my/inclusive_volume/:inclusive_volume_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id_or_my", "inclusive_volume", ":inclusive_volume_id" ], "variable": [ { "key": "org_id_or_my" }, { "key": "inclusive_volume_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a805d938-9ec0-411b-9189-e5e85daa0b1a" }, { "id": "86c1c237-1485-402c-a70e-bad46ba7acde", "name": "Organisation is not accessible or not valid in this context\n", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"pooled\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id_or_my/inclusive_volume/:inclusive_volume_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id_or_my", "inclusive_volume", ":inclusive_volume_id" ], "variable": [ { "key": "org_id_or_my" }, { "key": "inclusive_volume_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-86c1c237-1485-402c-a70e-bad46ba7acde" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a43550fb-3038-4599-a6ca-00e9e31076a6" } ], "id": "16fa02a4-5967-4fd6-9faf-3820e3c99d9f", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-16fa02a4-5967-4fd6-9faf-3820e3c99d9f" } ], "id": "09882620-8810-41f5-af15-52a9ec826de3", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-09882620-8810-41f5-af15-52a9ec826de3" }, { "name": "stats", "item": [ { "name": "daily", "item": [ { "name": "Daily organization traffic and cost statistics", "id": "28528e55-0ad2-4977-aeed-2a054df1ee08", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id_or_my/stats/daily?start_date=&end_date=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id_or_my", "stats", "daily" ], "query": [ { "description": "Filters results to data collected on or after this date.\nIf `end_date` isn't specified, the response includes data through the end of the selected month.\n", "key": "start_date", "value": "" }, { "description": "Filters results to data collected before this date.\nMust be used with `start_date`.\n", "key": "end_date", "value": "" } ], "variable": [ { "id": "2ee6b821-7ce7-4a0b-abad-49b28ca074a7", "key": "org_id_or_my", "value": "my", "description": "(Required) Numerical ID of an organization or the string `my` to use the currently authorized organization.\n" } ] }, "description": "Retrieves traffic and cost statistics for the selected organization and all child organizations, accumulated per day.\n\n\n By default, this call returns statistics for the current month.\n\n" }, "response": [ { "id": "9a32cc17-95f4-4aa8-b190-2e94518dff76", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id_or_my/stats/daily?start_date=&end_date=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id_or_my", "stats", "daily" ], "query": [ { "description": "Filters results to data collected on or after this date.\nIf `end_date` isn't specified, the response includes data through the end of the selected month.\n", "key": "start_date", "value": "" }, { "description": "Filters results to data collected before this date.\nMust be used with `start_date`.\n", "key": "end_date", "value": "" } ], "variable": [ { "key": "org_id_or_my" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"date\": \"\",\n \"data\": {\n \"cost\": \"\",\n \"currency_id\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n },\n \"traffic_type_id\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"volume\": \"\",\n \"volume_rx\": \"\",\n \"volume_tx\": \"\"\n },\n \"sms\": {\n \"cost\": \"\",\n \"currency_id\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n },\n \"traffic_type_id\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"volume\": \"\",\n \"volume_rx\": \"\",\n \"volume_tx\": \"\"\n }\n },\n {\n \"date\": \"\",\n \"data\": {\n \"cost\": \"\",\n \"currency_id\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n },\n \"traffic_type_id\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"volume\": \"\",\n \"volume_rx\": \"\",\n \"volume_tx\": \"\"\n },\n \"sms\": {\n \"cost\": \"\",\n \"currency_id\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n },\n \"traffic_type_id\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"volume\": \"\",\n \"volume_rx\": \"\",\n \"volume_tx\": \"\"\n }\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9a32cc17-95f4-4aa8-b190-2e94518dff76" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-28528e55-0ad2-4977-aeed-2a054df1ee08" } ], "id": "7e687119-7deb-4914-a03a-91a1ca55fd90", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7e687119-7deb-4914-a03a-91a1ca55fd90" }, { "name": "hourly", "item": [ { "name": "Hourly organization traffic statistics", "id": "f1825dad-4851-4123-a73f-6511f1ab1b66", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id_or_my/stats/hourly?start_date=&end_date=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id_or_my", "stats", "hourly" ], "query": [ { "description": "Filters results to data collected on or after this timestamp.\nIf not specified, the response includes data from the past three hours up to the current time.\n", "key": "start_date", "value": "" }, { "description": "Filters results to data collected before this timestamp.\nMust be used with `start_date`.\nIf not specified, defaults to one hour after the current time.\n", "key": "end_date", "value": "" } ], "variable": [ { "id": "3fd9ac57-196a-426e-9da7-8be338342559", "key": "org_id_or_my", "value": "my", "description": "(Required) Numerical ID of an organization or the string `my` to use the currently authorized organization.\n" } ] }, "description": "Retrieves traffic statistics for the selected organization and all child organizations, accumulated per hour.\n\n\n By default, this call returns statistics for the last three hours.\n\n" }, "response": [ { "id": "a7272069-5876-4e30-aa06-a3e3a5ed3b4f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id_or_my/stats/hourly?start_date=&end_date=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id_or_my", "stats", "hourly" ], "query": [ { "description": "Filters results to data collected on or after this timestamp.\nIf not specified, the response includes data from the past three hours up to the current time.\n", "key": "start_date", "value": "" }, { "description": "Filters results to data collected before this timestamp.\nMust be used with `start_date`.\nIf not specified, defaults to one hour after the current time.\n", "key": "end_date", "value": "" } ], "variable": [ { "key": "org_id_or_my" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"rx\": [\n \"\",\n \"\"\n ],\n \"tx\": [\n \"\",\n \"\"\n ]\n },\n \"sms\": {\n \"rx\": [\n \"\",\n \"\"\n ],\n \"tx\": [\n \"\",\n \"\"\n ]\n }\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a7272069-5876-4e30-aa06-a3e3a5ed3b4f" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f1825dad-4851-4123-a73f-6511f1ab1b66" } ], "id": "1b992a31-c147-499b-ba43-834a938c79e6", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1b992a31-c147-499b-ba43-834a938c79e6" }, { "name": "Monthly organization traffic and cost statistics", "id": "ed159feb-4ba5-43b9-a862-2ada5139d236", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id_or_my/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id_or_my", "stats" ], "variable": [ { "id": "9eb66bbd-e2d3-4802-9166-042d8a9f5fc4", "key": "org_id_or_my", "value": "", "description": "(Required) " } ] }, "description": "Retrieves traffic and cost statistics for the selected organization.\n\nTraffic statistics accumulate for the `current_month` and `last_month` of the selected organization and all child organizations.\nAll other returned values (SIM statistics, user counts, etc.) are only for the selected organization.\n" }, "response": [ { "id": "e98822a8-dafc-4719-8a85-10fa65cf15cc", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id_or_my/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id_or_my", "stats" ], "variable": [ { "key": "org_id_or_my" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"current_month\": {\n \"data\": {\n \"cost\": \"\",\n \"month\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n },\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"volume\": \"\",\n \"volume_rx\": \"\",\n \"volume_tx\": \"\"\n },\n \"sms\": {\n \"cost\": \"\",\n \"month\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n },\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"volume\": \"\",\n \"volume_rx\": \"\",\n \"volume_tx\": \"\"\n }\n },\n \"last_month\": {\n \"data\": {\n \"cost\": \"\",\n \"month\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n },\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"volume\": \"\",\n \"volume_rx\": \"\",\n \"volume_tx\": \"\"\n },\n \"sms\": {\n \"cost\": \"\",\n \"month\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n },\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"volume\": \"\",\n \"volume_rx\": \"\",\n \"volume_tx\": \"\"\n }\n },\n \"sim\": {\n \"issued\": \"\",\n \"factory_mode\": \"\",\n \"active\": \"\",\n \"suspended\": \"\",\n \"total\": \"\"\n },\n \"service_profiles\": \"\",\n \"tariff_profiles\": \"\",\n \"users\": \"\",\n \"active_chargeable_sims\": \"\",\n \"hosting_fees\": \"\",\n \"inclusive_volume\": {\n \"unpooled\": \"\",\n \"pooled\": \"\"\n },\n \"prepaid_balance\": {\n \"amount\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n },\n \"last_updated\": \"\"\n }\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e98822a8-dafc-4719-8a85-10fa65cf15cc" }, { "id": "cf41be79-39a3-4bd0-84dc-eb878f255387", "name": "Selected organisation not found or not accessible", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id_or_my/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id_or_my", "stats" ], "variable": [ { "key": "org_id_or_my" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cf41be79-39a3-4bd0-84dc-eb878f255387" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ed159feb-4ba5-43b9-a862-2ada5139d236" } ], "id": "ecd2207b-6ecb-462f-9adc-5bdaa2e3e7a0", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ecd2207b-6ecb-462f-9adc-5bdaa2e3e7a0" }, { "name": "tariff_plan", "item": [ { "name": "active", "item": [ { "name": "Get the active tariff plan for the given organization", "id": "7e405bd3-301a-480f-8c56-9b2992f28828", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id_or_my/tariff_plan/active", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id_or_my", "tariff_plan", "active" ], "variable": [ { "id": "af77b680-bd63-4ddc-b6f9-af4d2d2035d3", "key": "org_id_or_my", "value": "", "description": "(Required) " } ] }, "description": "Retrieve detailed information about the currently assigned `tariff_plan` of the given organisation.\nIt can either be accessed for the own organisation or a direct child organisation.\nThe `applied_price` field is calculated using the currently active SIM cards for the month.\n" }, "response": [ { "id": "9650398f-fb97-451d-b4af-af392368b1ec", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id_or_my/tariff_plan/active", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id_or_my", "tariff_plan", "active" ], "variable": [ { "key": "org_id_or_my" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"organisation_id\": \"\",\n \"start_date\": \"\",\n \"expiry_date\": \"\",\n \"sim_activated_rate\": \"\",\n \"sim_activated_idle_rate\": \"\",\n \"sim_suspended_rate\": \"\",\n \"sim_suspended_active_rate\": \"\",\n \"sim_activated_amount\": \"\",\n \"applied_price\": {\n \"sim_activated_rate\": [\n {\n \"scale_start\": \"\",\n \"rate\": \"\",\n \"volume\": \"\"\n },\n {\n \"scale_start\": \"\",\n \"rate\": \"\",\n \"volume\": \"\"\n }\n ]\n },\n \"tariff_plan\": {\n \"name\": \"\",\n \"description\": \"\",\n \"creation_date\": \"\",\n \"activation_date\": \"\",\n \"deprecation_date\": \"\",\n \"rate\": \"\",\n \"yearly_rate\": \"\",\n \"sim_activation_fee\": \"\",\n \"max_active_sims\": \"\",\n \"add_active_sims_rate\": \"\",\n \"add_active_sim_batch\": \"\",\n \"max_service_profiles\": \"\",\n \"max_tariff_profiles\": \"\",\n \"max_users\": \"\",\n \"minimum_runtime\": \"\",\n \"api_access_allowed\": \"\",\n \"vpn_access\": \"\",\n \"evaluation\": \"\",\n \"expiry_time\": \"\",\n \"used_count\": \"\",\n \"id\": \"\",\n \"price\": {\n \"sim_activated_rate\": [\n {\n \"scale_start\": \"\",\n \"rate\": \"\"\n },\n {\n \"scale_start\": \"\",\n \"rate\": \"\"\n }\n ]\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n },\n \"workspaces_enabled\": \"\"\n },\n \"tariff_plan_runtime\": {\n \"number_of_units\": \"\",\n \"time_unit_id\": \"\",\n \"id\": \"\"\n },\n \"active\": \"\",\n \"applied_rate\": \"\",\n \"id\": \"\",\n \"service_level\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"workspaces_enabled\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9650398f-fb97-451d-b4af-af392368b1ec" }, { "id": "c720ddbc-0869-4113-ba56-dbdd254fb409", "name": "Organisation not found or no active tariff plan", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id_or_my/tariff_plan/active", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id_or_my", "tariff_plan", "active" ], "variable": [ { "key": "org_id_or_my" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c720ddbc-0869-4113-ba56-dbdd254fb409" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7e405bd3-301a-480f-8c56-9b2992f28828" } ], "id": "5c81def4-7d86-4bf1-8e06-84aed0f52740", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5c81def4-7d86-4bf1-8e06-84aed0f52740" } ], "id": "17002e72-0f56-4c1c-a51c-7cf4907d1929", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-17002e72-0f56-4c1c-a51c-7cf4907d1929" } ], "id": "4a63ac2f-d0b5-44e5-b741-0bec787dcc67", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-4a63ac2f-d0b5-44e5-b741-0bec787dcc67" }, { "name": "{org_id}", "item": [ { "name": "tariff", "item": [ { "name": "Update assigned tariff", "id": "52a86bbb-f431-407a-8f47-e8f508d57861", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id/tariff", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id", "tariff" ], "variable": [ { "id": "4a183018-e2d7-45ea-91bb-ff904c89823e", "key": "org_id", "value": "", "description": "(Required) Numerical ID of an organization" } ] }, "description": "Allows an organisation to change their assigned tariff.\n\nThe following restrictions apply:\n* The organisation must not have more than one tariff assigned.\n* The tariff can be changed only for the own organisation and direct child organisations. The organisation status must be \"ACTIVE\".\n* If performing the change in self-service, the organisation needs to be in evaluation. Parent organisations are allowed to change the tariffs of production organisations.\n* The selected tariff must be active, visible to the requested organisation and must have the same currency. Parent organisations are allowed to assign private tariffs to their child organisations.\n\nIn addition to updating the assigned tariff, the system will also:\n* Update all of the organisations tariff profiles to use the new tariff.\n* Activate all ratezones in the tariff in order to ensure that the endpoints do not lose connection.\n* Expire all currently active inclusive volumes and custom rates and delete future ones.\n" }, "response": [ { "id": "35a2d28f-f31f-4e36-80f2-7853e6015e60", "name": "Response to a successful GET, also used for a POST if it does not result in a creation", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id/tariff", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id", "tariff" ], "variable": [ { "key": "org_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-35a2d28f-f31f-4e36-80f2-7853e6015e60" }, { "id": "bd7a9636-cf10-4d23-876c-9effe7c54d79", "name": "The request is malformed, e.g. the body cannot be parsed", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id/tariff", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id", "tariff" ], "variable": [ { "key": "org_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-bd7a9636-cf10-4d23-876c-9effe7c54d79" }, { "id": "20245d17-fc9e-430c-be42-2b1acfe64702", "name": "A non-existent resource is requested", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id/tariff", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id", "tariff" ], "variable": [ { "key": "org_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-20245d17-fc9e-430c-be42-2b1acfe64702" }, { "id": "177a1f3f-a34e-40b9-8746-974180c805ea", "name": "Body will return list of validation errors", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id/tariff", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id", "tariff" ], "variable": [ { "key": "org_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-177a1f3f-a34e-40b9-8746-974180c805ea" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-52a86bbb-f431-407a-8f47-e8f508d57861" } ], "id": "52e6795b-4ad3-49c5-bcc8-17b171794170", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-52e6795b-4ad3-49c5-bcc8-17b171794170" }, { "name": "tariff_plan", "item": [ { "name": "List organization tariff plans", "id": "af522cd3-f1ec-49f5-9b4f-3fabe62312fc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id/tariff_plan", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id", "tariff_plan" ], "variable": [ { "id": "4c510aae-2325-42e2-992d-f166f526eeed", "key": "org_id", "value": "", "description": "(Required) Numerical ID of an organization" } ] }, "description": "Retrieve a list of all Tariff Plans that are available for the given organisation.\nThe available tariff plans for one's own organisation can also be retrieved with a call to\n`/api/v1/organisation/my/tariff_plan`\n" }, "response": [ { "id": "c8a35640-0446-4406-aad0-3dcd80906772", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/organisation/:org_id/tariff_plan", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "organisation", ":org_id", "tariff_plan" ], "variable": [ { "key": "org_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"organisation_id\": \"\",\n \"start_date\": \"\",\n \"expiry_date\": \"\",\n \"sim_activated_rate\": \"\",\n \"sim_activated_idle_rate\": \"\",\n \"sim_suspended_rate\": \"\",\n \"sim_suspended_active_rate\": \"\",\n \"currency_id\": \"\",\n \"federation_allowed\": \"\",\n \"factory_test_mode_allowed\": \"\",\n \"service_level\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"active\": \"\",\n \"applied_rate\": \"\",\n \"price_model\": \"\",\n \"tariff_plan\": {\n \"organisation_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"tariff_plan_type_id\": \"\",\n \"min_tariff_plan_runtime_id\": \"\",\n \"level\": \"\",\n \"tariff_plan_runtime_id\": {},\n \"owner_organisation_id\": \"\",\n \"public_for_child_organisations\": \"\",\n \"creation_date\": \"\",\n \"activation_date\": \"\",\n \"deprecation_date\": \"\",\n \"notes\": {},\n \"rate\": \"\",\n \"yearly_rate\": \"\",\n \"sim_activation_fee\": \"\",\n \"max_active_sims\": \"\",\n \"add_active_sims_rate\": \"\",\n \"add_active_sim_batch\": \"\",\n \"max_service_profiles\": \"\",\n \"max_tariff_profiles\": \"\",\n \"max_users\": \"\",\n \"minimum_runtime\": \"\",\n \"api_access_allowed\": \"\",\n \"vpn_access\": \"\",\n \"private\": \"\",\n \"dtype\": \"\",\n \"evaluation\": \"\",\n \"expiry_time\": \"\",\n \"billing_disabled\": \"\",\n \"used_count\": \"\",\n \"id\": \"\",\n \"status\": {\n \"description\": \"\",\n \"tariff_plan_status_enum_id\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n },\n \"visibility\": {\n \"description\": \"\",\n \"id\": \"\"\n },\n \"price\": {\n \"sim_activated_rate\": [\n {\n \"scale_start\": \"\",\n \"rate\": \"\"\n },\n {\n \"scale_start\": \"\",\n \"rate\": \"\"\n }\n ]\n },\n \"service_level\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"federation_allowed\": \"\",\n \"factory_test_mode_allowed\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"organisation_id\": \"\",\n \"start_date\": \"\",\n \"expiry_date\": \"\",\n \"sim_activated_rate\": \"\",\n \"sim_activated_idle_rate\": \"\",\n \"sim_suspended_rate\": \"\",\n \"sim_suspended_active_rate\": \"\",\n \"currency_id\": \"\",\n \"federation_allowed\": \"\",\n \"factory_test_mode_allowed\": \"\",\n \"service_level\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"active\": \"\",\n \"applied_rate\": \"\",\n \"price_model\": \"\",\n \"tariff_plan\": {\n \"organisation_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"tariff_plan_type_id\": \"\",\n \"min_tariff_plan_runtime_id\": \"\",\n \"level\": \"\",\n \"tariff_plan_runtime_id\": {},\n \"owner_organisation_id\": \"\",\n \"public_for_child_organisations\": \"\",\n \"creation_date\": \"\",\n \"activation_date\": \"\",\n \"deprecation_date\": \"\",\n \"notes\": {},\n \"rate\": \"\",\n \"yearly_rate\": \"\",\n \"sim_activation_fee\": \"\",\n \"max_active_sims\": \"\",\n \"add_active_sims_rate\": \"\",\n \"add_active_sim_batch\": \"\",\n \"max_service_profiles\": \"\",\n \"max_tariff_profiles\": \"\",\n \"max_users\": \"\",\n \"minimum_runtime\": \"\",\n \"api_access_allowed\": \"\",\n \"vpn_access\": \"\",\n \"private\": \"\",\n \"dtype\": \"\",\n \"evaluation\": \"\",\n \"expiry_time\": \"\",\n \"billing_disabled\": \"\",\n \"used_count\": \"\",\n \"id\": \"\",\n \"status\": {\n \"description\": \"\",\n \"tariff_plan_status_enum_id\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n },\n \"visibility\": {\n \"description\": \"\",\n \"id\": \"\"\n },\n \"price\": {\n \"sim_activated_rate\": [\n {\n \"scale_start\": \"\",\n \"rate\": \"\"\n },\n {\n \"scale_start\": \"\",\n \"rate\": \"\"\n }\n ]\n },\n \"service_level\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"federation_allowed\": \"\",\n \"factory_test_mode_allowed\": \"\"\n }\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c8a35640-0446-4406-aad0-3dcd80906772" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-af522cd3-f1ec-49f5-9b4f-3fabe62312fc" } ], "id": "ceb74d81-0cf6-4f9d-8d5d-6d3931ea15eb", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ceb74d81-0cf6-4f9d-8d5d-6d3931ea15eb" } ], "id": "39b8ee9b-93c5-4da3-8d2a-dc32cda84253", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-39b8ee9b-93c5-4da3-8d2a-dc32cda84253" } ], "id": "d649d65b-b8b6-4f8d-a178-ee96347023f9", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d649d65b-b8b6-4f8d-a178-ee96347023f9" }, { "name": "rat_type", "item": [ { "name": "List RAT types", "id": "257b8fff-3887-48a4-85c5-ce77d94ff478", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/rat_type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "rat_type" ] }, "description": "Returns a list of supported RAT types.\n" }, "response": [ { "id": "0544a11b-40db-40cb-8371-b74cda6fcbfd", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/rat_type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "rat_type" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0544a11b-40db-40cb-8371-b74cda6fcbfd" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-257b8fff-3887-48a4-85c5-ce77d94ff478" } ], "id": "327f9cc9-5110-4c7f-8252-aea56a1ab615", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-327f9cc9-5110-4c7f-8252-aea56a1ab615" }, { "name": "service", "item": [ { "name": "{service_id}", "item": [ { "name": "traffic_limit", "item": [ { "name": "Get service SMS limit", "id": "be30f114-bcb7-4985-a839-90f63edb6534", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/service/:service_id/traffic_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service", ":service_id", "traffic_limit" ], "variable": [ { "id": "79d18ba1-ee06-4f03-9ec7-906de4236139", "key": "service_id", "value": "", "description": "(Required) " } ] }, "description": "SMS limits are system configuration parameters defined for a single service.\nSMS limits do not have direct effect, but have to be explicitly assigned to an endpoint or a service profile.\n" }, "response": [ { "id": "9d44413f-bcc8-4946-85c2-96e2976ebdfe", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service/:service_id/traffic_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service", ":service_id", "traffic_limit" ], "variable": [ { "key": "service_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"volume\": \"\",\n \"period\": {\n \"id\": \"\",\n \"time_units\": \"\",\n \"unit\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"volume\": \"\",\n \"period\": {\n \"id\": \"\",\n \"time_units\": \"\",\n \"unit\": \"\"\n }\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9d44413f-bcc8-4946-85c2-96e2976ebdfe" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-be30f114-bcb7-4985-a839-90f63edb6534" } ], "id": "a4718625-0b3f-4b0f-ba02-96aa9481c9ef", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a4718625-0b3f-4b0f-ba02-96aa9481c9ef" } ], "id": "1ab19116-b2cf-4a83-8fb8-33e0823b583e", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1ab19116-b2cf-4a83-8fb8-33e0823b583e" }, { "name": "List services", "id": "e7211e62-8c03-45cd-8a09-47f440b53ff4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/service", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service" ] }, "description": "Retrieves a collection of available services. Services are read only objects.\n\nService objects contain expanded traffic limit nested objects.\n" }, "response": [ { "id": "18f44521-2a95-4411-8b32-d406d40e40a1", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\",\n \"teleservice_code\": \"\",\n \"used_with_vlr\": \"\",\n \"used_with_sgsn\": \"\",\n \"traffic_type\": {}\n },\n {\n \"id\": \"\",\n \"description\": \"\",\n \"teleservice_code\": \"\",\n \"used_with_vlr\": \"\",\n \"used_with_sgsn\": \"\",\n \"traffic_type\": {}\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-18f44521-2a95-4411-8b32-d406d40e40a1" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e7211e62-8c03-45cd-8a09-47f440b53ff4" } ], "id": "b617d788-5cea-410d-98cc-99195bcf0c4e", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b617d788-5cea-410d-98cc-99195bcf0c4e" }, { "name": "service_level", "item": [ { "name": "Get list of service levels", "id": "84c7eccd-e4cb-41a4-b1e2-8a2273a6f962", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/service_level", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_level" ] }, "description": "Returns a list of service levels that can be configured on a tariff plan level.\nFor non-enterprise organisations, only own service levels will be returned.\nFor enterprise organisations, only the service levels of the parent organisation will be returned.\n" }, "response": [ { "id": "8f37d096-51b1-4c2e-a6c5-ff3b858ea7b9", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_level", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_level" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8f37d096-51b1-4c2e-a6c5-ff3b858ea7b9" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-84c7eccd-e4cb-41a4-b1e2-8a2273a6f962" } ], "id": "cccb7f1a-c6df-48b2-a777-e983efc519cb", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cccb7f1a-c6df-48b2-a777-e983efc519cb" }, { "name": "service_profile", "item": [ { "name": "{profile_id}", "item": [ { "name": "quota", "item": [ { "name": "{quota_type}", "item": [ { "name": "Remove all quotas of assigned endpoints", "id": "a1eebd28-0985-4360-9c27-3040a4cab277", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/quota/:quota_type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "quota", ":quota_type" ], "variable": [ { "id": "332f5dbb-872a-4dc7-ba6f-28e3443284e5", "key": "profile_id", "value": "", "description": "(Required) " }, { "id": "45ab22c9-a054-4bba-9744-7e8fe03d2b8c", "key": "quota_type", "value": "", "description": "(Required) " } ] }, "description": "Remove all quotas of endpoints which are assigned to this profile. Notice that `apply_data_quota` and/or\n`apply_sms_quota` have to be patched to false before, otherwise the endpoints will get blocked\nfor having no quota left.\nThis call will also return successfully if no endpoint is assigned or no quotas are set.\n" }, "response": [ { "id": "a764307a-9783-4542-aefb-8ebdd6dfb483", "name": "Successfully deleted the quota of all (0 or more) assigned endpoints.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/quota/:quota_type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "quota", ":quota_type" ], "variable": [ { "key": "profile_id" }, { "key": "quota_type" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a764307a-9783-4542-aefb-8ebdd6dfb483" }, { "id": "b5af6071-1d7f-4284-8079-17b6a0804599", "name": "Service profile not found or not part of this organisation.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/quota/:quota_type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "quota", ":quota_type" ], "variable": [ { "key": "profile_id" }, { "key": "quota_type" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b5af6071-1d7f-4284-8079-17b6a0804599" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a1eebd28-0985-4360-9c27-3040a4cab277" } ], "id": "5b0695cd-8a98-4543-8826-88ea5f469ce1", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5b0695cd-8a98-4543-8826-88ea5f469ce1" } ], "id": "216eaffd-1f40-4931-94ef-e840ac9d4f32", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-216eaffd-1f40-4931-94ef-e840ac9d4f32" }, { "name": "service", "item": [ { "name": "{service_id}", "item": [ { "name": "traffic_limit", "item": [ { "name": "{limit_id}", "item": [ { "name": "Add SMS limit to service profile", "id": "2891ee97-f572-49f5-8dbe-bdf8a1c1885a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/service/:service_id/traffic_limit/:limit_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "service", ":service_id", "traffic_limit", ":limit_id" ], "variable": [ { "id": "2519544d-3f36-46b5-9e99-a287432d8592", "key": "profile_id", "value": "", "description": "(Required) " }, { "id": "2a1f77f0-47f8-4b63-8f00-4f05505dad42", "key": "service_id", "value": "", "description": "(Required) " }, { "id": "6ec106f9-d967-43ab-9395-133ed6a586ee", "key": "limit_id", "value": "", "description": "(Required) " } ] }, "description": "Add SMS limit to a service policy." }, "response": [ { "id": "0659d9e7-0f1d-4899-a5c3-6b2f437087cf", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/service/:service_id/traffic_limit/:limit_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "service", ":service_id", "traffic_limit", ":limit_id" ], "variable": [ { "key": "profile_id" }, { "key": "service_id" }, { "key": "limit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0659d9e7-0f1d-4899-a5c3-6b2f437087cf" }, { "id": "de57a01c-ba87-48fa-9477-666d903b6895", "name": "SMS limit not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/service/:service_id/traffic_limit/:limit_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "service", ":service_id", "traffic_limit", ":limit_id" ], "variable": [ { "key": "profile_id" }, { "key": "service_id" }, { "key": "limit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-de57a01c-ba87-48fa-9477-666d903b6895" }, { "id": "6542798d-7f22-440c-82f2-d71b7313472d", "name": "General error happened when trying to add the SMS limit", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/service/:service_id/traffic_limit/:limit_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "service", ":service_id", "traffic_limit", ":limit_id" ], "variable": [ { "key": "profile_id" }, { "key": "service_id" }, { "key": "limit_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6542798d-7f22-440c-82f2-d71b7313472d" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2891ee97-f572-49f5-8dbe-bdf8a1c1885a" }, { "name": "Remove SMS limit from a service profile", "id": "2c360672-48f7-4fdb-9f81-b9ff7b4c02dd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/service/:service_id/traffic_limit/:limit_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "service", ":service_id", "traffic_limit", ":limit_id" ], "variable": [ { "id": "ff90cb4c-3175-41a4-a1e2-e05231a0c23d", "key": "profile_id", "value": "", "description": "(Required) " }, { "id": "a1c5381c-f31d-480b-95b4-7915d6f13bee", "key": "service_id", "value": "", "description": "(Required) " }, { "id": "65b5c72f-13a3-42f3-88f3-b64457a34e8a", "key": "limit_id", "value": "", "description": "(Required) " } ] }, "description": "Removes the SMS Limit (if any) from a given service profile." }, "response": [ { "id": "a4265eae-6555-4a5c-ac9b-f7fbffd44f99", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/service/:service_id/traffic_limit/:limit_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "service", ":service_id", "traffic_limit", ":limit_id" ], "variable": [ { "key": "profile_id" }, { "key": "service_id" }, { "key": "limit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a4265eae-6555-4a5c-ac9b-f7fbffd44f99" }, { "id": "3f636bd8-2999-4031-8d7e-4554da4e7314", "name": "General error happened when trying to add the SMS limit", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/service/:service_id/traffic_limit/:limit_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "service", ":service_id", "traffic_limit", ":limit_id" ], "variable": [ { "key": "profile_id" }, { "key": "service_id" }, { "key": "limit_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3f636bd8-2999-4031-8d7e-4554da4e7314" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2c360672-48f7-4fdb-9f81-b9ff7b4c02dd" } ], "id": "0ee03213-8999-481c-b040-76415c07a934", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0ee03213-8999-481c-b040-76415c07a934" } ], "id": "6fd7b9ce-e11f-4c03-a1ed-96e7808d7a85", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6fd7b9ce-e11f-4c03-a1ed-96e7808d7a85" }, { "name": "Add a service to a service profile", "id": "14ebafb0-562d-4d1a-b1a8-25866407532d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/service/:service_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "service", ":service_id" ], "variable": [ { "id": "8e58a608-3e1c-49a2-aaec-6962b6596ab6", "key": "profile_id", "value": "", "description": "(Required) " }, { "id": "ac288d6c-9816-4089-a89d-c3316a7910fd", "key": "service_id", "value": "", "description": "(Required) " } ] }, "description": "Add service to the collection of services associated to a profile.\nMultiple services can be assigned, but each only once.\n\n\n Adding the voice service with an id of `3` to a service profile will be successful, but this feature **isn't enabled** by the platform.\n\n" }, "response": [ { "id": "3e654679-75b0-45d3-93f5-d6acd9347d33", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/service/:service_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "service", ":service_id" ], "variable": [ { "key": "profile_id" }, { "key": "service_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3e654679-75b0-45d3-93f5-d6acd9347d33" }, { "id": "c03621c9-1cf1-4046-b490-a6daa6512a66", "name": "Unexpected error in API call. See HTTP response body for details.", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/service/:service_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "service", ":service_id" ], "variable": [ { "key": "profile_id" }, { "key": "service_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c03621c9-1cf1-4046-b490-a6daa6512a66" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-14ebafb0-562d-4d1a-b1a8-25866407532d" }, { "name": "Remove a service from a service profile", "id": "9dcd441c-258e-456f-a822-8e225a96f20f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/service/:service_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "service", ":service_id" ], "variable": [ { "id": "1604cc93-1d6b-42d3-ac19-e6bf223de1dd", "key": "profile_id", "value": "", "description": "(Required) " }, { "id": "f577c297-0265-4472-8828-7f94e59feb76", "key": "service_id", "value": "", "description": "(Required) " } ] }, "description": "Remove service from the collection of services associated to a profile. A service can only be removed if it has no assigned traffic limits." }, "response": [ { "id": "118cc81d-7c56-41db-899c-0c49a27d738d", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/service/:service_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "service", ":service_id" ], "variable": [ { "key": "profile_id" }, { "key": "service_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-118cc81d-7c56-41db-899c-0c49a27d738d" }, { "id": "fa7a0ddd-355d-4a04-b506-ba27b3e6a875", "name": "Unexpected error in API call. See HTTP response body for details.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/service/:service_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "service", ":service_id" ], "variable": [ { "key": "profile_id" }, { "key": "service_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-fa7a0ddd-355d-4a04-b506-ba27b3e6a875" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9dcd441c-258e-456f-a822-8e225a96f20f" } ], "id": "963cc877-e01c-4dc2-a7e4-8f2efd8e7193", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-963cc877-e01c-4dc2-a7e4-8f2efd8e7193" } ], "id": "95b1822f-aec1-4147-a809-612474c65ba6", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-95b1822f-aec1-4147-a809-612474c65ba6" }, { "name": "traffic_limit", "item": [ { "name": "{limit_id}", "item": [ { "name": "Remove data limit from a service profile", "id": "670d7fa9-7f49-45bb-9788-425dbd32e112", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/traffic_limit/:limit_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "traffic_limit", ":limit_id" ], "variable": [ { "id": "aff99c57-469e-407a-a0e0-6bd43e1a4d83", "key": "profile_id", "value": "", "description": "(Required) " }, { "id": "5d1f7628-e399-49a9-9742-4317f49126b2", "key": "limit_id", "value": "", "description": "(Required) " } ] } }, "response": [ { "id": "f6251f89-06e7-4612-a3d1-720f03286f21", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/traffic_limit/:limit_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "traffic_limit", ":limit_id" ], "variable": [ { "key": "profile_id" }, { "key": "limit_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f6251f89-06e7-4612-a3d1-720f03286f21" }, { "id": "7c0bba0b-c463-458f-b201-3811f60d1278", "name": "Service Profile is not found or not accessible", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/traffic_limit/:limit_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "traffic_limit", ":limit_id" ], "variable": [ { "key": "profile_id" }, { "key": "limit_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7c0bba0b-c463-458f-b201-3811f60d1278" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-670d7fa9-7f49-45bb-9788-425dbd32e112" } ], "id": "947cfdb1-317c-4209-81a3-12d63da79f07", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-947cfdb1-317c-4209-81a3-12d63da79f07" }, { "name": "List data limits of service profile", "id": "3eaef68e-a5f7-454a-9983-ac77ee0531bc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/traffic_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "traffic_limit" ], "variable": [ { "id": "42a7a690-8391-414b-957b-ea01181aefd1", "key": "profile_id", "value": "", "description": "(Required) " } ] }, "description": "List data limits of the service profile. These have the possibility to add\ncustom `volume` values per data limit, as well if they apply only to data traffic over\nsatellite rat type, which incurs higher cost, or to cellular.\n\nThese data limits will not disable any other traffic limits, but can be used to achieve the\nsame outcome.\n" }, "response": [ { "id": "cf3072ed-6236-43ac-8691-a9b93df9e14a", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/traffic_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "traffic_limit" ], "variable": [ { "key": "profile_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"service\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"satellite_only\": \"\",\n \"period\": {\n \"id\": \"\",\n \"time_units\": \"\",\n \"unit\": \"\"\n },\n \"volume\": \"\",\n \"warning_percent\": \"\"\n },\n {\n \"id\": \"\",\n \"service\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"satellite_only\": \"\",\n \"period\": {\n \"id\": \"\",\n \"time_units\": \"\",\n \"unit\": \"\"\n },\n \"volume\": \"\",\n \"warning_percent\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cf3072ed-6236-43ac-8691-a9b93df9e14a" }, { "id": "904c38fa-eeaf-4bba-af3d-6173703d85b4", "name": "Service Profile is not found or not accessible", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/traffic_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "traffic_limit" ], "variable": [ { "key": "profile_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-904c38fa-eeaf-4bba-af3d-6173703d85b4" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3eaef68e-a5f7-454a-9983-ac77ee0531bc" }, { "name": "Add data limit to service profile", "id": "e8f672d6-8511-4a8b-b39a-f5c1de277a41", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"service\": {\n \"id\": \"38\"\n },\n \"volume\": \"\",\n \"satellite_only\": false,\n \"period\": {\n \"id\": \"2\"\n },\n \"warning_percent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/traffic_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "traffic_limit" ], "variable": [ { "id": "07132436-273a-4616-af6a-de2f5a814c5f", "key": "profile_id", "value": "", "description": "(Required) " } ] }, "description": "This API endpoint allows you to add a data limit to a service profile.\nA data limit is a rule that defines how much data a service can consume within a certain period.\nThis is useful for managing your data usage and avoiding overage charges.\n\nYou can use this API to customize the data limit for your service profile by specifying the service type, time period, volume threshold, and warning percentage.\nYou can also choose to apply the data limit only to satellite radio access technology (RAT) types that use satellites for communication.\n\n\n Only users with `User` or `Admin` roles can use this API endpoint.\n You can only add **one** data limit per service and satellite RAT type combination.\n\n\nTo change the data limit, you must first delete the existing data limit and then add a new one.\n**Exception**: Creating a temporary [traffic limit extension](/developers/api/endpoint/create-endpoint-traffic-limit-extension).\n" }, "response": [ { "id": "638a8aec-da2c-4c9d-9c4a-410523ef7b4c", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service\": {\n \"id\": \"38\"\n },\n \"volume\": \"\",\n \"satellite_only\": false,\n \"period\": {\n \"id\": \"2\"\n },\n \"warning_percent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/traffic_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "traffic_limit" ], "variable": [ { "key": "profile_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-638a8aec-da2c-4c9d-9c4a-410523ef7b4c" }, { "id": "710feead-f889-490d-9f3e-8c47bb1a80b1", "name": "One or more values of the data limit are invalid", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service\": {\n \"id\": \"38\"\n },\n \"volume\": \"\",\n \"satellite_only\": false,\n \"period\": {\n \"id\": \"2\"\n },\n \"warning_percent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/traffic_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "traffic_limit" ], "variable": [ { "key": "profile_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-710feead-f889-490d-9f3e-8c47bb1a80b1" }, { "id": "7f930ac3-c476-4add-81eb-a3817b2f9a5d", "name": "Service Profile is not found or not accessible", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service\": {\n \"id\": \"38\"\n },\n \"volume\": \"\",\n \"satellite_only\": false,\n \"period\": {\n \"id\": \"2\"\n },\n \"warning_percent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/traffic_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "traffic_limit" ], "variable": [ { "key": "profile_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7f930ac3-c476-4add-81eb-a3817b2f9a5d" }, { "id": "2f3306bc-2d05-453b-afdf-e0fc074f0c5a", "name": "Data Limit for the same traffic type and rat type combination already exists", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service\": {\n \"id\": \"38\"\n },\n \"volume\": \"\",\n \"satellite_only\": false,\n \"period\": {\n \"id\": \"2\"\n },\n \"warning_percent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/traffic_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "traffic_limit" ], "variable": [ { "key": "profile_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2f3306bc-2d05-453b-afdf-e0fc074f0c5a" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e8f672d6-8511-4a8b-b39a-f5c1de277a41" }, { "name": "Delete all data limits of a service profile", "id": "8ff260fa-8224-480d-b39f-fe2d5ee9a4ce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/traffic_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "traffic_limit" ], "variable": [ { "id": "c53a7be2-b6aa-4efa-96df-fd04d10cc273", "key": "profile_id", "value": "", "description": "(Required) " } ] }, "description": "Delete all data limits. This will not influence the assignment style limits.\n" }, "response": [ { "id": "edd70843-89c6-4655-b10e-83f447e1c3cd", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/traffic_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "traffic_limit" ], "variable": [ { "key": "profile_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-edd70843-89c6-4655-b10e-83f447e1c3cd" }, { "id": "87b1520e-9597-46f1-83b6-6ee6e45eef95", "name": "Service Profile is not found or not accessible", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id/traffic_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id", "traffic_limit" ], "variable": [ { "key": "profile_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-87b1520e-9597-46f1-83b6-6ee6e45eef95" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8ff260fa-8224-480d-b39f-fe2d5ee9a4ce" } ], "id": "bde1ccb6-edf6-445b-b0b1-e66b9cd5d800", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-bde1ccb6-edf6-445b-b0b1-e66b9cd5d800" }, { "name": "Retrieve a service profile", "id": "0c126ad6-ea91-4a79-abf8-adb6e00df908", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id" ], "variable": [ { "id": "27dc60d3-cf50-4bbc-9d4c-45dac3f44ecf", "key": "profile_id", "value": "", "description": "(Required) " } ] }, "description": "Retrieve a service profile with a given id." }, "response": [ { "id": "6be73dd5-db04-4f12-b4f3-51b5840614ab", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id" ], "variable": [ { "key": "profile_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"allowed_3g\": \"\",\n \"allowed_4g\": \"\",\n \"allowed_nb_iot\": \"\",\n \"allowed_nb_iot_geo\": \"\",\n \"apply_sms_quota\": \"\",\n \"apply_data_quota\": \"\",\n \"retail\": \"\",\n \"sms_p2p_int\": \"\",\n \"sms_p2p_ext\": \"\",\n \"prepaid\": \"\",\n \"nipdp\": \"\",\n \"used_count\": \"\",\n \"api_callback\": {},\n \"api_secret\": {},\n \"moc_callback\": {},\n \"esme_interface_type\": {},\n \"breakout_region\": {},\n \"ip_firewall_rule_set\": {\n \"ip_firewall_profiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"added\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"added\": \"\"\n }\n ],\n \"enforce\": \"\"\n }\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6be73dd5-db04-4f12-b4f3-51b5840614ab" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0c126ad6-ea91-4a79-abf8-adb6e00df908" }, { "name": "Delete a service profile", "id": "42fd523b-c448-41f9-9af6-efbfc5153153", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id" ], "variable": [ { "id": "20c321dd-1946-4d45-b77c-e4fb2a73b01e", "key": "profile_id", "value": "", "description": "(Required) " } ] }, "description": "Deletes a service profile and all its associations with services and traffic limits.\nA service profile can only be deleted if it is **not** selected on an endpoint.\nIf it is not selected on an endpoint, the used_count is 0.\n" }, "response": [ { "id": "6f6f263e-f54d-4949-b000-1d049ac44f61", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id" ], "variable": [ { "key": "profile_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6f6f263e-f54d-4949-b000-1d049ac44f61" }, { "id": "2d788e3b-d49f-4c82-84e2-77407c81eec4", "name": "Unexpected error in API call. See HTTP response body for details.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id" ], "variable": [ { "key": "profile_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2d788e3b-d49f-4c82-84e2-77407c81eec4" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-42fd523b-c448-41f9-9af6-efbfc5153153" }, { "name": "Update service profile", "id": "07b15e02-9377-483b-a135-c08dd33074cd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"allowed_3g\": \"\",\n \"allowed_4g\": \"\",\n \"allowed_nb_iot\": \"\",\n \"allowed_nb_iot_geo\": \"\",\n \"apply_sms_quota\": \"\",\n \"apply_data_quota\": \"\",\n \"retail\": \"\",\n \"sms_p2p_int\": \"\",\n \"sms_p2p_ext\": \"\",\n \"prepaid\": \"\",\n \"nipdp\": \"\",\n \"api_callback\": {},\n \"api_secret\": {},\n \"moc_callback\": {},\n \"esme_interface_type\": {},\n \"breakout_region\": {},\n \"dns\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id" ], "variable": [ { "id": "f0e0413f-4f4e-4506-b5e3-b9b0c4c7a31f", "key": "profile_id", "value": "", "description": "(Required) " } ] }, "description": "Update a service profile with a given id.\n\nEditable fields:\n* `name` (String optional)\n* `description` (String optional)\n* `allowed_3g` (boolean optional)\n* `allowed_4g` (boolean optional). Allows or restricts connectivity for 4G/LTE and LTE-M networks.\n* `allowed_nb_iot` (boolean optional)\n* `allowed_nb_iot_geo` (boolean optional). Allows or restricts NB-IoT connectivity over satellite networks.\n* **DEPRECATED** `apply_quota` (boolean optional, defaults to false). Use `apply_data_quota` instead. Will be ignored if `apply_data_quota` is present.\n* `apply_data_quota` (boolean optional, defaults to false)\n* `apply_sms_quota` (boolean optional, defaults to false)\n* `retail` (boolean optional, defaults to false)\n* `sms_p2p_int` (boolean optional, defaults to true)\n* `sms_p2p_ext` (boolean optional, defaults to true)\n* **DEPRECATED** `prepaid` (boolean optional, defaults to false)\n* `nipdp` (boolean optional, defaults to false)\n* `api_callback` (object optional) can be emptied by setting the id to null (\"api_callback\":{\"id\":null})\n* `api_secret` (object optional) can be emptied by setting the id to null (\"api_secret\":{\"id\":null})\n* `moc_callback` (object optional) can be emptied by setting the id to null (\"moc_callback\":{\"id\":null})\n* `esme_interface_type` (object optional)\n* `breakout_region` (object optional)\n* `dns` (object optional)\n" }, "response": [ { "id": "b489f910-42e3-4259-a864-f32215b1fae0", "name": "Successfully updated the Service Profile", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"allowed_3g\": \"\",\n \"allowed_4g\": \"\",\n \"allowed_nb_iot\": \"\",\n \"allowed_nb_iot_geo\": \"\",\n \"apply_sms_quota\": \"\",\n \"apply_data_quota\": \"\",\n \"retail\": \"\",\n \"sms_p2p_int\": \"\",\n \"sms_p2p_ext\": \"\",\n \"prepaid\": \"\",\n \"nipdp\": \"\",\n \"api_callback\": {},\n \"api_secret\": {},\n \"moc_callback\": {},\n \"esme_interface_type\": {},\n \"breakout_region\": {},\n \"dns\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/service_profile/:profile_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile", ":profile_id" ], "variable": [ { "key": "profile_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b489f910-42e3-4259-a864-f32215b1fae0" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-07b15e02-9377-483b-a135-c08dd33074cd" } ], "id": "c19ec71c-f77a-403e-b1c4-ab8f0b3ed204", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c19ec71c-f77a-403e-b1c4-ab8f0b3ed204" }, { "name": "List service profiles", "id": "5b3cbe8f-5032-45f4-a6ee-d889f8c2bff7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile" ] }, "description": "Retrieves a collection of all service profiles for your organization.\n\nReturned service profiles contain just the total count of associated services, so this is the short view.\n" }, "response": [ { "id": "3f63971a-1367-4887-9cb2-5f1d83be8c4e", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/service_profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"used_count\": \"\",\n \"allowed_3g\": \"\",\n \"allowed_4g\": \"\",\n \"allowed_nb_iot\": \"\",\n \"allowed_nb_iot_geo\": \"\",\n \"apply_sms_quota\": \"\",\n \"apply_data_quota\": \"\",\n \"ip_firewall_rule_set\": {\n \"ip_firewall_profiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"added\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"added\": \"\"\n }\n ],\n \"enforce\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"used_count\": \"\",\n \"allowed_3g\": \"\",\n \"allowed_4g\": \"\",\n \"allowed_nb_iot\": \"\",\n \"allowed_nb_iot_geo\": \"\",\n \"apply_sms_quota\": \"\",\n \"apply_data_quota\": \"\",\n \"ip_firewall_rule_set\": {\n \"ip_firewall_profiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"added\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"added\": \"\"\n }\n ],\n \"enforce\": \"\"\n }\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3f63971a-1367-4887-9cb2-5f1d83be8c4e" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5b3cbe8f-5032-45f4-a6ee-d889f8c2bff7" }, { "name": "Create service profile", "id": "bf4ad629-4c61-48b0-a726-0fb2d8e48d59", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"allowed_3g\": \"\",\n \"allowed_4g\": \"\",\n \"allowed_nb_iot\": \"\",\n \"allowed_nb_iot_geo\": \"\",\n \"apply_sms_quota\": \"\",\n \"apply_data_quota\": \"\",\n \"retail\": \"\",\n \"sms_p2p_int\": \"\",\n \"sms_p2p_ext\": \"\",\n \"prepaid\": \"\",\n \"nipdp\": \"\",\n \"api_callback\": {},\n \"api_secret\": {},\n \"moc_callback\": {},\n \"esme_interface_type\": {},\n \"breakout_region\": {},\n \"dns\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/service_profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile" ] }, "description": "Creates a new Service Profile. A `name` must be specified for the Service Profile and all other fields are optional.\n\nEditable fields:\n* `name` (String required)\n* `description` (String optional)\n* `allowed_3g` (boolean optional, defaults to true)\n* `allowed_4g` (boolean optional, defaults to true). Allows or restricts connectivity for 4G/LTE and LTE-M networks.\n* `allowed_nb_iot` (boolean optional, defaults to true)\n* `allowed_nb_iot_geo` (boolean optional, defaults to false). Allows or restricts NB-IoT connectivity over satellite networks.\n* **DEPRECATED** `apply_quota` (boolean optional, defaults to false). Use `apply_data_quota` instead. Will be ignored if `apply_data_quota` is present.\n* `apply_data_quota` (boolean optional, defaults to false)\n* `apply_sms_quota` (boolean optional, defaults to false)\n* `retail` (boolean optional, defaults to false)\n* `sms_p2p_int` (boolean optional, defaults to true)\n* `sms_p2p_ext` (boolean optional, defaults to true)\n* **DEPRECATED** `prepaid` (boolean optional, defaults to false)\n* `nipdp` (boolean optional, defaults to false)\n* `api_callback` (object optional)\n* `api_secret` (object optional)\n* `moc_callback` (object optional)\n* `esme_interface_type` (object optional)\n* `breakout_region` (object optional)\n* `dns` (object optional)\n\n\n Enabling services (SMS, Data etc.) is done via `PUT` to `/api/v1/service_profile/{profile_id}/service/{service_id}`.\n\n" }, "response": [ { "id": "ebfba7da-3492-46e1-aabd-7b4eab237d4f", "name": "Resource Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"allowed_3g\": \"\",\n \"allowed_4g\": \"\",\n \"allowed_nb_iot\": \"\",\n \"allowed_nb_iot_geo\": \"\",\n \"apply_sms_quota\": \"\",\n \"apply_data_quota\": \"\",\n \"retail\": \"\",\n \"sms_p2p_int\": \"\",\n \"sms_p2p_ext\": \"\",\n \"prepaid\": \"\",\n \"nipdp\": \"\",\n \"api_callback\": {},\n \"api_secret\": {},\n \"moc_callback\": {},\n \"esme_interface_type\": {},\n \"breakout_region\": {},\n \"dns\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/service_profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "service_profile" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ebfba7da-3492-46e1-aabd-7b4eab237d4f" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-bf4ad629-4c61-48b0-a726-0fb2d8e48d59" } ], "id": "cfc8bfe0-f2cb-4f89-a93a-c1db74953bd8", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cfc8bfe0-f2cb-4f89-a93a-c1db74953bd8" }, { "name": "sim", "item": [ { "name": "migration", "item": [ { "name": "workspace", "item": [ { "name": "Migrate SIMs between Workspaces", "id": "791f0318-ef02-4e7e-bb6a-d24988a567d9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"target_workspace\": {\n \"id\": \"\"\n },\n \"sims\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"iccids\": [\n \"\",\n \"\"\n ],\n \"iccid_range\": {\n \"start\": \"\",\n \"end\": \"\"\n },\n \"allowed_sim_statuses\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"dry_run\": true,\n \"auto_detach_devices\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim/migration/workspace", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "migration", "workspace" ] }, "description": "Migrate SIMs from one Workspace to another.\n\n## Requirements\n\n- The calling user must have **Administrator** permissions on both the target and source Workspaces\n- The target Workspace must be an enterprise Workspace\n- Only 500 SIMs can be migrated per request\n- You must provide exactly one of: `sims`, `iccids`, or `iccid_range`\n\n\n This endpoint requires authentication with [user credentials](/developers/auth/user-credentials), as application tokens are scoped to a single Workspace.\n\n\n## Behavior\n\n- **Dry run mode**: The `dry_run` parameter defaults to `true`.\n Set it to `false` to execute the migration.\n- **Activated SIMs**: SIMs in status `ACTIVATED` are automatically suspended during migration.\n- **Attached devices**: If SIMs are attached to devices, set `auto_detach_devices: true` or the request fails.\n\n\n The request fails if one or more SIMs don't meet the requirements for migration.\n Check the `errors` array in the response for details.\n\n" }, "response": [ { "id": "6267180c-d8e1-4afe-892e-38ede2462fba", "name": "Successful migration request.\nIf `dry_run` was set to `false`, the migration is processed.\nIf `dry_run` was set to `true`, the response contains a summary of the changes that would be executed.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"target_workspace\": {\n \"id\": \"\"\n },\n \"sims\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"iccids\": [\n \"\",\n \"\"\n ],\n \"iccid_range\": {\n \"start\": \"\",\n \"end\": \"\"\n },\n \"allowed_sim_statuses\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"dry_run\": true,\n \"auto_detach_devices\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim/migration/workspace", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "migration", "workspace" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sim_count\": \"\",\n \"dry_run\": \"\",\n \"target_workspace\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"auto_detach_devices\": \"\",\n \"sims\": [\n {\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"id\": \"\",\n \"iccid\": \"\",\n \"iccid_with_luhn\": \"\",\n \"endpoint\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"source_workspace\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"id\": \"\",\n \"iccid\": \"\",\n \"iccid_with_luhn\": \"\",\n \"endpoint\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"source_workspace\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"allowed_sim_statuses\": [\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6267180c-d8e1-4afe-892e-38ede2462fba" }, { "id": "f1fcf3ff-4502-4a22-9465-d278f1a1d18a", "name": "The request is malformed.\n\nCommon causes:\n\n- Exceeds the maximum count of 500 SIMs\n- Multiple SIM identifiers provided (only one of `sims`, `iccids`, or `iccid_range` is allowed)\n- Invalid ICCID format (must be exactly 19 digits)\n- ICCID range `end` value", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"target_workspace\": {\n \"id\": \"\"\n },\n \"sims\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"iccids\": [\n \"\",\n \"\"\n ],\n \"iccid_range\": {\n \"start\": \"\",\n \"end\": \"\"\n },\n \"allowed_sim_statuses\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"dry_run\": true,\n \"auto_detach_devices\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim/migration/workspace", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "migration", "workspace" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f1fcf3ff-4502-4a22-9465-d278f1a1d18a" }, { "id": "3920f7d2-4533-4e7e-a543-2d3492d38011", "name": "One or more SIMs or the target Workspace couldn't be found or are inaccessible.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"target_workspace\": {\n \"id\": \"\"\n },\n \"sims\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"iccids\": [\n \"\",\n \"\"\n ],\n \"iccid_range\": {\n \"start\": \"\",\n \"end\": \"\"\n },\n \"allowed_sim_statuses\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"dry_run\": true,\n \"auto_detach_devices\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim/migration/workspace", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "migration", "workspace" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3920f7d2-4533-4e7e-a543-2d3492d38011" }, { "id": "6b580368-505a-4010-b90d-4e3c49c3f2a5", "name": "One or more SIMs don't meet the requirements for migration.\n\nThe response includes an `errors` array with details about which SIMs failed and why.\n\n| Error Code | Message | Resolution |\n|------------|---------|------------|\n| 1502 | SIM(s) attached to dev", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"target_workspace\": {\n \"id\": \"\"\n },\n \"sims\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"iccids\": [\n \"\",\n \"\"\n ],\n \"iccid_range\": {\n \"start\": \"\",\n \"end\": \"\"\n },\n \"allowed_sim_statuses\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"dry_run\": true,\n \"auto_detach_devices\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim/migration/workspace", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "migration", "workspace" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"error_code\": \"\",\n \"message\": \"\",\n \"sims\": [\n {\n \"id\": \"\",\n \"iccid\": \"\",\n \"iccid_with_luhn\": \"\",\n \"endpoint\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"source_workspace\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"iccid\": \"\",\n \"iccid_with_luhn\": \"\",\n \"endpoint\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"source_workspace\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n {\n \"error_code\": \"\",\n \"message\": \"\",\n \"sims\": [\n {\n \"id\": \"\",\n \"iccid\": \"\",\n \"iccid_with_luhn\": \"\",\n \"endpoint\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"source_workspace\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"iccid\": \"\",\n \"iccid_with_luhn\": \"\",\n \"endpoint\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"source_workspace\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6b580368-505a-4010-b90d-4e3c49c3f2a5" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-791f0318-ef02-4e7e-bb6a-d24988a567d9" } ], "id": "ecd21b17-294b-450a-8508-b8ad7ca6b90e", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ecd21b17-294b-450a-8508-b8ad7ca6b90e" } ], "id": "82f64ef3-1d13-42a5-bee9-dfc86734ff5c", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-82f64ef3-1d13-42a5-bee9-dfc86734ff5c" }, { "name": "multi", "item": [ { "name": "Bulk delete SIMs", "id": "578082c4-9cde-4144-aa91-ea582ba1fba8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim/multi", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "multi" ] }, "description": "Deletes multiple SIMs based on the provided list of IDs.\n\n\n Deleted SIMs cannot be recovered.\n\n" }, "response": [ { "id": "d2e8ff90-b6ba-47b9-89ac-01a4c81d8dea", "name": "SIMs deleted successfully", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim/multi", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "multi" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d2e8ff90-b6ba-47b9-89ac-01a4c81d8dea" }, { "id": "08f0f83a-0ad8-4e70-ad68-4649e1d67aad", "name": "Request body is malformed", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim/multi", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "multi" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-08f0f83a-0ad8-4e70-ad68-4649e1d67aad" }, { "id": "cedf49dc-412a-4e01-bba2-e5c0d0bb73ee", "name": "User doesn't have permission to bulk delete SIMs\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim/multi", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "multi" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cedf49dc-412a-4e01-bba2-e5c0d0bb73ee" }, { "id": "0b93d1fd-8989-4143-8c22-9ee761d3cd66", "name": "A given SIM ID isn't found\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim/multi", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "multi" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0b93d1fd-8989-4143-8c22-9ee761d3cd66" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-578082c4-9cde-4144-aa91-ea582ba1fba8" } ], "id": "f174202e-6bd9-4d99-9ef8-9b465239ac3d", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f174202e-6bd9-4d99-9ef8-9b465239ac3d" }, { "name": "operation", "item": [ { "name": "action", "item": [ { "name": "List SIM operation actions", "id": "d609c849-e07a-4917-91a8-38cf7c6cf921", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation/action", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation", "action" ] }, "description": "List possible SIM operation action objects used in responses and requests.\n" }, "response": [ { "id": "0bf526e8-644a-450f-a981-140b86f1afd6", "name": "List of SIM operation actions", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation/action", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation", "action" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0bf526e8-644a-450f-a981-140b86f1afd6" }, { "id": "2755612b-179b-4ecb-8a89-9672bd2a7cde", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation/action", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation", "action" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2755612b-179b-4ecb-8a89-9672bd2a7cde" }, { "id": "d4a5c35e-4a1a-4995-ab1a-5fb50e865706", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation/action", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation", "action" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d4a5c35e-4a1a-4995-ab1a-5fb50e865706" }, { "id": "7e3975a4-1249-4e0a-8092-1f34c885f98f", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation/action", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation", "action" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7e3975a4-1249-4e0a-8092-1f34c885f98f" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d609c849-e07a-4917-91a8-38cf7c6cf921" } ], "id": "9c8f0a9c-f6a0-45ce-a079-06d735d1b059", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9c8f0a9c-f6a0-45ce-a079-06d735d1b059" }, { "name": "status", "item": [ { "name": "List SIM operation status", "id": "cc9433fb-2131-495e-9bc0-2394ce44dcf8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation", "status" ] }, "description": "List possible SIM operation status objects used in responses.\n" }, "response": [ { "id": "24c6a5ba-7ab6-42f3-82a6-b7e1f0939ef4", "name": "List of SIM operation status", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-24c6a5ba-7ab6-42f3-82a6-b7e1f0939ef4" }, { "id": "01fd17c2-91ac-4508-93bc-8d7e3a530378", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation", "status" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-01fd17c2-91ac-4508-93bc-8d7e3a530378" }, { "id": "64cc3f71-3f1c-4ed2-a791-4a1865a09885", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation", "status" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-64cc3f71-3f1c-4ed2-a791-4a1865a09885" }, { "id": "fa2c205f-ad06-4dc8-8a49-59e2fd792d7e", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation", "status" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-fa2c205f-ad06-4dc8-8a49-59e2fd792d7e" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cc9433fb-2131-495e-9bc0-2394ce44dcf8" } ], "id": "e95f1bd8-0f45-4f56-9e4b-7d8cf16364b4", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e95f1bd8-0f45-4f56-9e4b-7d8cf16364b4" }, { "name": "{operation_id}", "item": [ { "name": "Get SIM operation details", "id": "c16fb9a8-2722-4ce4-8a42-13d8f6151e78", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation/:operation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation", ":operation_id" ], "variable": [ { "id": "1bb411ee-fea9-4af2-b4c3-de385a9345cd", "key": "operation_id", "value": "", "description": "(Required) " } ] }, "description": "Get details of a specific SIM operation.\n" }, "response": [ { "id": "29cf9ff8-45e0-47e1-a51d-b561333d4adc", "name": "SIM operation detail", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation/:operation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation", ":operation_id" ], "variable": [ { "key": "operation_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"action\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"creation_date\": \"\",\n \"last_updated_at\": \"\",\n \"product\": {\n \"id\": \"\"\n },\n \"finalization_date\": \"\",\n \"target\": [\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n },\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n }\n ],\n \"total_count\": \"\",\n \"failed_count\": \"\",\n \"success_count\": \"\",\n \"error\": [\n {\n \"eid\": \"\",\n \"message\": \"\"\n },\n {\n \"eid\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-29cf9ff8-45e0-47e1-a51d-b561333d4adc" }, { "id": "a28e65c2-643c-49fd-b648-d94a9de35c70", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation/:operation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation", ":operation_id" ], "variable": [ { "key": "operation_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a28e65c2-643c-49fd-b648-d94a9de35c70" }, { "id": "253a5d07-c367-40d1-8029-59186939a97a", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation/:operation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation", ":operation_id" ], "variable": [ { "key": "operation_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-253a5d07-c367-40d1-8029-59186939a97a" }, { "id": "23bb06c3-3557-4e45-8a45-8c83ed76e294", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation/:operation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation", ":operation_id" ], "variable": [ { "key": "operation_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-23bb06c3-3557-4e45-8a45-8c83ed76e294" }, { "id": "55929b65-8803-4f8b-a436-77792bf09105", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation/:operation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation", ":operation_id" ], "variable": [ { "key": "operation_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-55929b65-8803-4f8b-a436-77792bf09105" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c16fb9a8-2722-4ce4-8a42-13d8f6151e78" } ], "id": "ffe2e021-e5cc-4d28-9066-0c65c5e3d270", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ffe2e021-e5cc-4d28-9066-0c65c5e3d270" }, { "name": "List SIM operations for organization", "id": "fc59a952-f2a2-4cf7-bf7f-fe7e598796d4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `action`\n- `status`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `action`\n- `status`\n- `creation_date`\n- `finalization_date`\n", "key": "sort", "value": "" } ] }, "description": "List all SIM operations for your organization.\n" }, "response": [ { "id": "a13e6151-4776-456d-8282-9da55dfff2ca", "name": "SIM operation list", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `action`\n- `status`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `action`\n- `status`\n- `creation_date`\n- `finalization_date`\n", "key": "sort", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"action\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"creation_date\": \"\",\n \"last_updated_at\": \"\",\n \"product\": {\n \"id\": \"\"\n },\n \"finalization_date\": \"\",\n \"target\": [\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n },\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n }\n ],\n \"total_count\": \"\",\n \"failed_count\": \"\",\n \"success_count\": \"\",\n \"error\": [\n {\n \"eid\": \"\",\n \"message\": \"\"\n },\n {\n \"eid\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"action\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"creation_date\": \"\",\n \"last_updated_at\": \"\",\n \"product\": {\n \"id\": \"\"\n },\n \"finalization_date\": \"\",\n \"target\": [\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n },\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n }\n ],\n \"total_count\": \"\",\n \"failed_count\": \"\",\n \"success_count\": \"\",\n \"error\": [\n {\n \"eid\": \"\",\n \"message\": \"\"\n },\n {\n \"eid\": \"\",\n \"message\": \"\"\n }\n ]\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a13e6151-4776-456d-8282-9da55dfff2ca" }, { "id": "abb6c104-3572-4734-83cf-8a5fc6486fe6", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `action`\n- `status`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `action`\n- `status`\n- `creation_date`\n- `finalization_date`\n", "key": "sort", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-abb6c104-3572-4734-83cf-8a5fc6486fe6" }, { "id": "ad1fa56d-54b9-416d-a3d0-7a066d649dd1", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `action`\n- `status`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `action`\n- `status`\n- `creation_date`\n- `finalization_date`\n", "key": "sort", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ad1fa56d-54b9-416d-a3d0-7a066d649dd1" }, { "id": "63a8aa0f-e0ac-46ad-a422-a7ddcbfcb904", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `action`\n- `status`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `action`\n- `status`\n- `creation_date`\n- `finalization_date`\n", "key": "sort", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-63a8aa0f-e0ac-46ad-a422-a7ddcbfcb904" }, { "id": "99321297-59b4-4171-a138-9374e36cdd82", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `action`\n- `status`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `action`\n- `status`\n- `creation_date`\n- `finalization_date`\n", "key": "sort", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-99321297-59b4-4171-a138-9374e36cdd82" }, { "id": "8ae91b05-67e5-4cdb-921c-b40180a19a58", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/operation?page=1&per_page=100&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation" ], "query": [ { "description": "Page number (1-based).", "key": "page", "value": "1" }, { "description": "Items per page.", "key": "per_page", "value": "100" }, { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `action`\n- `status`\n", "key": "q", "value": "" }, { "description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `action`\n- `status`\n- `creation_date`\n- `finalization_date`\n", "key": "sort", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8ae91b05-67e5-4cdb-921c-b40180a19a58" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-fc59a952-f2a2-4cf7-bf7f-fe7e598796d4" }, { "name": "Trigger SIM operation", "id": "ec6a08ef-ade1-4282-9275-630ce6b1ec48", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"action\": {\n \"id\": \"\"\n },\n \"target\": [\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n },\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n }\n ],\n \"product\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim/operation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation" ] }, "description": "Trigger a SIM operation.\n" }, "response": [ { "id": "0dec538a-5d47-49cf-982c-3aad850e6d84", "name": "Created, SIM operation scheduled", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"action\": {\n \"id\": \"\"\n },\n \"target\": [\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n },\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n }\n ],\n \"product\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim/operation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"action\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"creation_date\": \"\",\n \"last_updated_at\": \"\",\n \"product\": {\n \"id\": \"\"\n },\n \"finalization_date\": \"\",\n \"target\": [\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n },\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n }\n ],\n \"total_count\": \"\",\n \"failed_count\": \"\",\n \"success_count\": \"\",\n \"error\": [\n {\n \"eid\": \"\",\n \"message\": \"\"\n },\n {\n \"eid\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0dec538a-5d47-49cf-982c-3aad850e6d84" }, { "id": "9ff9d5c1-f7a2-46ea-8e13-f360a82bba1b", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"action\": {\n \"id\": \"\"\n },\n \"target\": [\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n },\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n }\n ],\n \"product\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim/operation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9ff9d5c1-f7a2-46ea-8e13-f360a82bba1b" }, { "id": "885d8291-82f9-4b16-bbc2-bb81f392cf19", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"action\": {\n \"id\": \"\"\n },\n \"target\": [\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n },\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n }\n ],\n \"product\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim/operation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-885d8291-82f9-4b16-bbc2-bb81f392cf19" }, { "id": "68c4ad06-d1a1-48fa-8621-892bca8a9a92", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"action\": {\n \"id\": \"\"\n },\n \"target\": [\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n },\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n }\n ],\n \"product\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim/operation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-68c4ad06-d1a1-48fa-8621-892bca8a9a92" }, { "id": "71ec7fa5-0249-4f8b-a427-25100ef13bc5", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"action\": {\n \"id\": \"\"\n },\n \"target\": [\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n },\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n }\n ],\n \"product\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim/operation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-71ec7fa5-0249-4f8b-a427-25100ef13bc5" }, { "id": "2ad8983e-c542-4bae-a462-3fe3654b30ac", "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"action\": {\n \"id\": \"\"\n },\n \"target\": [\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n },\n {\n \"sim\": {\n \"id\": \"\"\n },\n \"eid\": \"\"\n }\n ],\n \"product\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim/operation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "operation" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2ad8983e-c542-4bae-a462-3fe3654b30ac" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ec6a08ef-ade1-4282-9275-630ce6b1ec48" } ], "id": "2e77b1ff-bc2a-4f0b-b852-6f85046a794f", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2e77b1ff-bc2a-4f0b-b852-6f85046a794f" }, { "name": "status", "item": [ { "name": "List SIM statuses", "id": "6b6b3221-50d5-4759-bb63-e4bd136e145f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "status" ] }, "description": "Returns a list of available [SIM statuses](/developers/reference/sim#sim-statuses).\n" }, "response": [ { "id": "cea9010b-fd5f-47dd-a9b6-759d87ec100d", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cea9010b-fd5f-47dd-a9b6-759d87ec100d" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6b6b3221-50d5-4759-bb63-e4bd136e145f" } ], "id": "c9ebf36d-e860-4919-8f34-fe17f91afe7e", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c9ebf36d-e860-4919-8f34-fe17f91afe7e" }, { "name": "unlinked_product_stats", "item": [ { "name": "Get product statistics on unlinked eSIMs", "id": "fe70c37b-2093-478d-96fd-01e1979aac6e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/unlinked_product_stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "unlinked_product_stats" ] }, "description": "Receive statistics on how many eSIMs are unlinked (available profile status), grouped by products.\n" }, "response": [ { "id": "d3298605-0829-4f21-8bef-6faa83b7fb83", "name": "Unlinked product statistics", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/unlinked_product_stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "unlinked_product_stats" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"product\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"quantity\": \"\"\n },\n {\n \"product\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"quantity\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d3298605-0829-4f21-8bef-6faa83b7fb83" }, { "id": "1a8316aa-04d7-41f1-bca8-9dd2f89976fa", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/unlinked_product_stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "unlinked_product_stats" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1a8316aa-04d7-41f1-bca8-9dd2f89976fa" }, { "id": "170539d7-e44c-45f5-abf0-372092e1f0e5", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/unlinked_product_stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "unlinked_product_stats" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-170539d7-e44c-45f5-abf0-372092e1f0e5" }, { "id": "3e6cb40b-18b8-433f-a0df-a6767eb67003", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/unlinked_product_stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", "unlinked_product_stats" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3e6cb40b-18b8-433f-a0df-a6767eb67003" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-fe70c37b-2093-478d-96fd-01e1979aac6e" } ], "id": "41ff5418-d30c-4983-a9db-9969217194ff", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-41ff5418-d30c-4983-a9db-9969217194ff" }, { "name": "{sim_id}", "item": [ { "name": "event", "item": [ { "name": "List SIM events", "id": "f6eb4bc8-b74a-4a47-b930-fe2e6c7b4c02", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/:sim_id/event?page=&per_page=&sort=&q=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", ":sim_id", "event" ], "query": [ { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "per_page", "value": "" }, { "description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n", "key": "sort", "value": "" }, { "description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n", "key": "q", "value": "" } ], "variable": [ { "id": "b8b1bc0c-e9d8-4f2c-9272-5076aca86a48", "key": "sim_id", "value": "", "description": "(Required) Numeric ID of a SIM" } ] }, "description": "Returns the list of events, filtered, sorted and paged according to query parameters.\n\n\n This API endpoint deviates from the specified conventions and may not return the same HTTP Codes as the higher layer call (`/api/v1/sim/{sim_id}`).\n\n In case the requested `{sim_id}` doesn't exist or is not accessible for the user, **HTTP 200** will be returned with empty **[]** as long as the provided `{sim_id}` is a number and all parameters are valid.\n\n Please take that into consideration when building automation on top of the error behavior of this endpoint.\n\n" }, "response": [ { "id": "d0b2a4da-6c7c-4d5d-8209-9f2c9b6b50c5", "name": "Successfully returned a list of SIM events", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/:sim_id/event?page=&per_page=&sort=&q=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", ":sim_id", "event" ], "query": [ { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "per_page", "value": "" }, { "description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n", "key": "sort", "value": "" }, { "description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n", "key": "q", "value": "" } ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"timestamp\": \"\",\n \"alert\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"event_type\": {},\n \"event_source\": {},\n \"event_severity\": {},\n \"organisation\": {},\n \"endpoint\": {},\n \"sim\": {},\n \"imsi\": {}\n },\n {\n \"timestamp\": \"\",\n \"alert\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"event_type\": {},\n \"event_source\": {},\n \"event_severity\": {},\n \"organisation\": {},\n \"endpoint\": {},\n \"sim\": {},\n \"imsi\": {}\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d0b2a4da-6c7c-4d5d-8209-9f2c9b6b50c5" }, { "id": "224dfd6e-304b-4d0f-903b-ad34fc6b089c", "name": "**Bad Request** due to incorrect **Paging** Parameters, **Sorting** Parameter or incorrect `{sim_id}`\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/:sim_id/event?page=&per_page=&sort=&q=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", ":sim_id", "event" ], "query": [ { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "per_page", "value": "" }, { "description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n", "key": "sort", "value": "" }, { "description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n", "key": "q", "value": "" } ], "variable": [ { "key": "sim_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-224dfd6e-304b-4d0f-903b-ad34fc6b089c" }, { "id": "6dbc1a97-91dc-4e4f-8ac2-e1ab511fcc6c", "name": "**Unprocessable Entity** due to incorrect **Query** parameters\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/:sim_id/event?page=&per_page=&sort=&q=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", ":sim_id", "event" ], "query": [ { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "per_page", "value": "" }, { "description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n", "key": "sort", "value": "" }, { "description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n", "key": "q", "value": "" } ], "variable": [ { "key": "sim_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6dbc1a97-91dc-4e4f-8ac2-e1ab511fcc6c" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f6eb4bc8-b74a-4a47-b930-fe2e6c7b4c02" } ], "id": "685f8753-10ac-4e49-8ba7-9970f580c5b6", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-685f8753-10ac-4e49-8ba7-9970f580c5b6" }, { "name": "stats", "item": [ { "name": "daily", "item": [ { "name": "Daily SIM usage statistics", "id": "bc3530f2-989e-4cc9-81c7-8907c5f41aaf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/:sim_id/stats/daily", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", ":sim_id", "stats", "daily" ], "variable": [ { "id": "831f8a96-2692-425f-ae4d-c54832ceaa0d", "key": "sim_id", "value": "", "description": "(Required) " } ] }, "description": "\n Data traffic cost statistics (`cost` field in the `data` object) have been deprecated.\n\n\nRetrieves SIM usage statistics accumulated per day.\nBy default, the response includes statistics for the current month.\n\n`start_date` and an `end_date` can be provided as query parameters to retrieve statistics for a specific time frame.\n\nExample request: `/api/v1/sim/123/stats/daily?end_date=2019-03-21&start_date=2019-03-01`\n" }, "response": [ { "id": "af294021-7694-4be9-9c07-a1cb3d1663d0", "name": "Successfully returned the daily SIM statistics for the provided dates and ID.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/:sim_id/stats/daily", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", ":sim_id", "stats", "daily" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-af294021-7694-4be9-9c07-a1cb3d1663d0" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-bc3530f2-989e-4cc9-81c7-8907c5f41aaf" } ], "id": "3ce5213b-99b6-416d-b43c-b279fb24d853", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3ce5213b-99b6-416d-b43c-b279fb24d853" }, { "name": "SIM usage and cost statistics", "id": "b308f7ba-973a-4f59-b189-a857dbfd1bdf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/:sim_id/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", ":sim_id", "stats" ], "variable": [ { "id": "dd0b79a3-6a13-471f-8172-9956dd302a7f", "key": "sim_id", "value": "", "description": "(Required) " } ] }, "description": "\n You can only retrieve data traffic costs for organizations without multi-inclusive volumes.\n\n\nRetrieves SIM usage and cost statistics for a given ID.\nUsage statistics are sorted by `data` and `sms`.\n\nReturns statistics from the following periods:\n* `last_month`: Previous billing month, from the first to last day (for example, February 1-29, 2024, when you send the request in March 2024).\n* `current_month`: Current month, with statistics calculated up to and including the date requested (for example, March 1-8, 2024, when you sent the request on March 8, 2024).\n* `last_hour`: Previous 60 minutes, accumulated per minute and organized by data or SMS received by the device (`rx`) and transmitted by the device (`tx`).\n\n\n `last_month` and `current_month` are only included in the responses if traffic exists.\n Those responses include a generated `id` value that's comprised of the SIM ID, year, month, and traffic type ID (`5` for data and `6` for SMS).\n\n For example, if you send a request in March 2024 for SIM ID `123456`, the `id` for data in the current month is `1234562024035`.\n\n" }, "response": [ { "id": "eca7908b-e8de-4887-aa7f-8bc85073a1a3", "name": "Successfully returned the SIM statistics associated with the provided `id`.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/:sim_id/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", ":sim_id", "stats" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"last_month\": {\n \"data\": {\n \"sim_id\": \"\",\n \"month\": \"\",\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"traffic_type_id\": \"\",\n \"last_updated\": \"\",\n \"cost\": \"\",\n \"currency_id\": \"\",\n \"id\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n },\n \"sms\": {\n \"sim_id\": \"\",\n \"month\": \"\",\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"traffic_type_id\": \"\",\n \"last_updated\": \"\",\n \"cost\": \"\",\n \"currency_id\": \"\",\n \"id\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n }\n },\n \"current_month\": {\n \"data\": {\n \"sim_id\": \"\",\n \"month\": \"\",\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"traffic_type_id\": \"\",\n \"last_updated\": \"\",\n \"cost\": \"\",\n \"currency_id\": \"\",\n \"id\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n },\n \"sms\": {\n \"sim_id\": \"\",\n \"month\": \"\",\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"traffic_type_id\": \"\",\n \"last_updated\": \"\",\n \"cost\": \"\",\n \"currency_id\": \"\",\n \"id\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n }\n },\n \"last_hour\": {\n \"data\": {\n \"sim_id\": \"\",\n \"month\": \"\",\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"traffic_type_id\": \"\",\n \"last_updated\": \"\",\n \"cost\": \"\",\n \"currency_id\": \"\",\n \"id\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n },\n \"sms\": {\n \"sim_id\": \"\",\n \"month\": \"\",\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"traffic_type_id\": \"\",\n \"last_updated\": \"\",\n \"cost\": \"\",\n \"currency_id\": \"\",\n \"id\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"last_month\": {\n \"data\": {\n \"sim_id\": \"\",\n \"month\": \"\",\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"traffic_type_id\": \"\",\n \"last_updated\": \"\",\n \"cost\": \"\",\n \"currency_id\": \"\",\n \"id\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n },\n \"sms\": {\n \"sim_id\": \"\",\n \"month\": \"\",\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"traffic_type_id\": \"\",\n \"last_updated\": \"\",\n \"cost\": \"\",\n \"currency_id\": \"\",\n \"id\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n }\n },\n \"current_month\": {\n \"data\": {\n \"sim_id\": \"\",\n \"month\": \"\",\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"traffic_type_id\": \"\",\n \"last_updated\": \"\",\n \"cost\": \"\",\n \"currency_id\": \"\",\n \"id\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n },\n \"sms\": {\n \"sim_id\": \"\",\n \"month\": \"\",\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"traffic_type_id\": \"\",\n \"last_updated\": \"\",\n \"cost\": \"\",\n \"currency_id\": \"\",\n \"id\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n }\n },\n \"last_hour\": {\n \"data\": {\n \"sim_id\": \"\",\n \"month\": \"\",\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"traffic_type_id\": \"\",\n \"last_updated\": \"\",\n \"cost\": \"\",\n \"currency_id\": \"\",\n \"id\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n },\n \"sms\": {\n \"sim_id\": \"\",\n \"month\": \"\",\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"traffic_type_id\": \"\",\n \"last_updated\": \"\",\n \"cost\": \"\",\n \"currency_id\": \"\",\n \"id\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n }\n }\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-eca7908b-e8de-4887-aa7f-8bc85073a1a3" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b308f7ba-973a-4f59-b189-a857dbfd1bdf" } ], "id": "9622d15f-fe03-495a-a699-0e5dada31b38", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9622d15f-fe03-495a-a699-0e5dada31b38" }, { "name": "SIM details", "id": "65273bf1-2845-4f1d-a248-5631f767caca", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/:sim_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", ":sim_id" ], "variable": [ { "id": "3c7e9280-905a-4bff-a595-0fd238cf7088", "key": "sim_id", "value": "", "description": "(Required) " } ] }, "description": "Retrieves SIM details for a given ID." }, "response": [ { "id": "e828c6f2-3dda-4c1d-93b4-760969306215", "name": "Successfully returned the SIM details associated with the provided `id`.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/:sim_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", ":sim_id" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"iccid\": \"\",\n \"eid\": \"\",\n \"production_date\": \"\",\n \"activation_date\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"customer_org\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"mcc\": \"\",\n \"iso_code\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n },\n \"issuer_org\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"mcc\": \"\",\n \"iso_code\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n },\n \"reseller_org\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"mcc\": \"\",\n \"iso_code\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n },\n \"endpoint\": {\n \"id\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"model\": {\n \"id\": \"\",\n \"description\": \"\",\n \"memory_size\": \"\",\n \"formfactor\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"manufacturer\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e828c6f2-3dda-4c1d-93b4-760969306215" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-65273bf1-2845-4f1d-a248-5631f767caca" }, { "name": "Delete a SIM", "id": "63af1c54-9898-4f14-b654-5b4d505cf490", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/:sim_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", ":sim_id" ], "variable": [ { "id": "3fe227d6-312a-4d83-ac84-1297971e95b8", "key": "sim_id", "value": "", "description": "(Required) " } ] }, "description": "\n Deleted SIMs cannot be recovered.\n\n\nDeletes a SIM.\n\nThe following restrictions apply when deleting SIMs:\n* SIMs with an assigned endpoint cannot be deleted.\n* Resellers cannot delete SIMs they have sold.\n" }, "response": [ { "id": "d67fb8b5-0368-46a6-8b1a-98b443b01c48", "name": "Successfully fulfilled the request with no additional content to send in the response payload body.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/:sim_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", ":sim_id" ], "variable": [ { "key": "sim_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d67fb8b5-0368-46a6-8b1a-98b443b01c48" }, { "id": "0238724a-eecd-4cb3-b2fa-682a8814b903", "name": "Request couldn't be satisfied. Typically happens when the `reseller_org_id` field isn't `null` and the value matches the organization ID making the request.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim/:sim_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", ":sim_id" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0238724a-eecd-4cb3-b2fa-682a8814b903" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-63af1c54-9898-4f14-b654-5b4d505cf490" }, { "name": "Update a SIM", "id": "47cfdc69-569a-4116-a554-be737227ea54", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"issuer_org\": {\n \"id\": \"\"\n },\n \"reseller_org\": {\n \"id\": \"\"\n },\n \"customer_org\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim/:sim_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", ":sim_id" ], "variable": [ { "id": "bd0a277a-4b19-471c-9466-d7d6f35aeade", "key": "sim_id", "value": "", "description": "(Required) " } ] }, "description": "Updates a SIM resource.\n\nYou can provide the following fields with this request:\n* `issuer_org` (Object optional) - change to a direct child organization of the appropriate type\n* `reseller_org` (Object optional) - change to a direct child organization of the appropriate type or empty (`\"reseller_org\": { \"id\": null }` or `\"reseller_org\": {}`)\n* `customer_org` (Object optional) - change to own organization or a direct child organization of type \"Enterprise\" or empty (`\"customer_org\": { \"id\": null }` or `\"customer_org\": {}`)\n* `status` (Object optional) - update the SIM status\n\nThe following restrictions apply when updating SIMs:\n* Users from the issuer organization can change any updatable field\n* Users from the reseller organization can update the `reseller_org` or `customer_org` fields\n* Users from the customer organization can only update the `status` field\n* `issuer_org` can change to a child organization of the type \"Mobile Network Operator\" or \"Service Provider\"\n* `reseller_org` can change to child organization of the following types: \"Mobile Network Operator\", \"Service Provider\", or \"Reseller\"\n* `customer_org` can change to a child organization of an \"Enterprise\" type\n* `status` can update from \"Issued\" (`\"id\": 0`) to either \"Activated\" (`\"id\": 1`) or \"Factory Test\" (`\"id\": 4`)\n* `status` can only update from \"Factory Test\" (`\"id\": 4`) to \"Activated\" (`\"id\": 1`)\n* `status` can switch between \"Activated\" (`\"id\": 1`) and \"Suspended\" (`\"id\": 2`)\n\n\n emnify charges for activated SIMs. To avoid accruing unexpected charges, update the SIM `status` to \"Suspended\" (`\"id\": 2`).\n\n" }, "response": [ { "id": "20bfb31f-183f-4d80-ad53-b65f6e18ffef", "name": "Successfully fulfilled the request with no additional content to send in the response payload body.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"issuer_org\": {\n \"id\": \"\"\n },\n \"reseller_org\": {\n \"id\": \"\"\n },\n \"customer_org\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim/:sim_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", ":sim_id" ], "variable": [ { "key": "sim_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-20bfb31f-183f-4d80-ad53-b65f6e18ffef" }, { "id": "d6c7cb62-29c7-45ab-aecf-b5dfef60caad", "name": "Unexpected error in the API call. See the HTTP response body for details.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"issuer_org\": {\n \"id\": \"\"\n },\n \"reseller_org\": {\n \"id\": \"\"\n },\n \"customer_org\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim/:sim_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim", ":sim_id" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d6c7cb62-29c7-45ab-aecf-b5dfef60caad" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-47cfdc69-569a-4116-a554-be737227ea54" } ], "id": "9bc4dbcb-2e34-4c41-92c2-ee9367f5dc30", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9bc4dbcb-2e34-4c41-92c2-ee9367f5dc30" }, { "name": "List SIMs", "id": "f5fcd84e-b78f-4a6e-ac54-138f6a206537", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/sim?q=&sort=&page=&per_page=2000", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim" ], "query": [ { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n* `id`\n* `issuer_org`\n* `reseller_org`\n* `customer_org`\n* `iccid`\n* `iccid_with_luhn`\n* `status`\n* `production_date`\n* `imsi`\n* `msisdn`\n* `endpoint`\n* `model`\n* `eid`\n* `satellite_capable`\n", "key": "q", "value": "" }, { "description": "Sort parameter in `` format.\nSort properties according to a comma-separated list from the allowed fields:\n\n* `id`\n* `issuer_org`\n* `reseller_org`\n* `customer_org`\n* `iccid`\n* `eid`\n* `status`\n* `production_date`\n* `endpoint`\n* `model`\n\nIf no sorting options are specified, the response will be sorted by `id`.\n\nSupported operators:\n* `-`: Descending order\n* `+`: Ascending order\n\nThe response will be shown in ascending order if no operator is specified.\n", "key": "sort", "value": "" }, { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page (max. 2500)", "key": "per_page", "value": "2000" } ] }, "description": "Returns a list of SIMs filtered, sorted, and paged according to query parameters." }, "response": [ { "id": "acb99baf-2dc6-4b57-8da6-105f820b010f", "name": "Successfully returned a list of SIMs.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim?q=&sort=&page=&per_page=2000", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim" ], "query": [ { "description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n* `id`\n* `issuer_org`\n* `reseller_org`\n* `customer_org`\n* `iccid`\n* `iccid_with_luhn`\n* `status`\n* `production_date`\n* `imsi`\n* `msisdn`\n* `endpoint`\n* `model`\n* `eid`\n* `satellite_capable`\n", "key": "q", "value": "" }, { "description": "Sort parameter in `` format.\nSort properties according to a comma-separated list from the allowed fields:\n\n* `id`\n* `issuer_org`\n* `reseller_org`\n* `customer_org`\n* `iccid`\n* `eid`\n* `status`\n* `production_date`\n* `endpoint`\n* `model`\n\nIf no sorting options are specified, the response will be sorted by `id`.\n\nSupported operators:\n* `-`: Descending order\n* `+`: Ascending order\n\nThe response will be shown in ascending order if no operator is specified.\n", "key": "sort", "value": "" }, { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page (max. 2500)", "key": "per_page", "value": "2000" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"iccid\": \"\",\n \"eid\": \"\",\n \"production_date\": \"\",\n \"activation_date\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"customer_org\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"mcc\": \"\",\n \"iso_code\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n },\n \"issuer_org\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"mcc\": \"\",\n \"iso_code\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n },\n \"reseller_org\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"mcc\": \"\",\n \"iso_code\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n },\n \"endpoint\": {\n \"id\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"model\": {\n \"id\": \"\",\n \"description\": \"\",\n \"memory_size\": \"\",\n \"formfactor\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"manufacturer\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"iccid\": \"\",\n \"eid\": \"\",\n \"production_date\": \"\",\n \"activation_date\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"customer_org\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"mcc\": \"\",\n \"iso_code\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n },\n \"issuer_org\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"mcc\": \"\",\n \"iso_code\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n },\n \"reseller_org\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"mcc\": \"\",\n \"iso_code\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n },\n \"endpoint\": {\n \"id\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"model\": {\n \"id\": \"\",\n \"description\": \"\",\n \"memory_size\": \"\",\n \"formfactor\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"manufacturer\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-acb99baf-2dc6-4b57-8da6-105f820b010f" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f5fcd84e-b78f-4a6e-ac54-138f6a206537" } ], "id": "22b8073e-76da-473c-8dd1-4b0054f8e8fe", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-22b8073e-76da-473c-8dd1-4b0054f8e8fe" }, { "name": "sim_batch", "item": [ { "name": "bic", "item": [ { "name": "{bic}", "item": [ { "name": "Validate SIM batch by BIC", "id": "6c8e5ab5-36c0-4e37-a660-8541c329762d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/sim_batch/bic/:bic", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim_batch", "bic", ":bic" ], "variable": [ { "id": "d987fe19-8862-4d4a-9cf2-3b025f5f0b4f", "key": "bic", "value": "", "description": "(Required) " } ] }, "description": "Checks the given BIC code and the contained SIMs if they can be registered.\n" }, "response": [ { "id": "01537cca-e6d0-402e-8c6b-c1af3a3c5a3f", "name": "Batch is valid and can be registered", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim_batch/bic/:bic", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim_batch", "bic", ":bic" ], "variable": [ { "key": "bic" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sim_batch_status_id\": \"\",\n \"bsn\": \"\",\n \"bic\": \"\",\n \"quantity\": \"\",\n \"sim_model_id\": \"\",\n \"issuer_org_id\": \"\",\n \"customer_org_id\": \"\",\n \"reseller_org_id\": \"\",\n \"activated\": \"\",\n \"logistic_center_id\": \"\",\n \"article_id\": \"\",\n \"id\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"model\": {\n \"id\": \"\",\n \"description\": \"\",\n \"memory_size\": \"\",\n \"formfactor\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"manufacturer\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-01537cca-e6d0-402e-8c6b-c1af3a3c5a3f" }, { "id": "d015a8d3-8080-4cf6-b004-8d1f8e23a4ce", "name": "Batch is already registered", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim_batch/bic/:bic", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim_batch", "bic", ":bic" ], "variable": [ { "key": "bic" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d015a8d3-8080-4cf6-b004-8d1f8e23a4ce" }, { "id": "301bd607-f057-4bbc-b324-fcc415fe3b09", "name": "No Batch with the given BIC found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim_batch/bic/:bic", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim_batch", "bic", ":bic" ], "variable": [ { "key": "bic" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-301bd607-f057-4bbc-b324-fcc415fe3b09" }, { "id": "395ece13-76f0-4872-8cef-121bb99501b5", "name": "Batch contains SIMs registered to another organisation", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/sim_batch/bic/:bic", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim_batch", "bic", ":bic" ], "variable": [ { "key": "bic" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-395ece13-76f0-4872-8cef-121bb99501b5" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6c8e5ab5-36c0-4e37-a660-8541c329762d" }, { "name": "Register a given batch by BIC", "id": "4331dec2-f9fa-4f8d-b1fe-2b6403c8b2a2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"sim_status\": {\n \"id\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim_batch/bic/:bic", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim_batch", "bic", ":bic" ], "variable": [ { "id": "6aab0f44-6cc4-4b92-b111-7af1bfb80d6e", "key": "bic", "value": "", "description": "(Required) " } ] }, "description": "Registers the given SIM batch, assigns all SIMs to the organisation,\nand sets the status of all contained SIMs to the given value.\n\nIf the `factory_test_mode_allowed` flag is set to true on the tariff plan assignment\nor it is enabled in the tariff plan, the SIM batch can be also registered with an initial\nstatus of `4 = Factory Test`, thus setting all of the contained SIMs to factory test\nstatus. In turn, the `activation_date` of these SIMs will not be set yet, but when the factory\ntest volume is consumed, the auto activation date is reached or they are patched to `Activated`\nstate afterwards.\n" }, "response": [ { "id": "dc6b8eba-db53-4d77-88a6-1319436f2dd7", "name": "Batch successfully registered and assigned all SIMS", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"sim_status\": {\n \"id\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim_batch/bic/:bic", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim_batch", "bic", ":bic" ], "variable": [ { "key": "bic" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sim\": [\n {\n \"id\": \"\",\n \"iccid\": \"\",\n \"eid\": \"\",\n \"production_date\": \"\",\n \"activation_date\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"customer_org\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"mcc\": \"\",\n \"iso_code\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n },\n \"issuer_org\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"mcc\": \"\",\n \"iso_code\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n },\n \"reseller_org\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"mcc\": \"\",\n \"iso_code\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n },\n \"endpoint\": {\n \"id\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"model\": {\n \"id\": \"\",\n \"description\": \"\",\n \"memory_size\": \"\",\n \"formfactor\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"manufacturer\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"iccid\": \"\",\n \"eid\": \"\",\n \"production_date\": \"\",\n \"activation_date\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"customer_org\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"mcc\": \"\",\n \"iso_code\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n },\n \"issuer_org\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"mcc\": \"\",\n \"iso_code\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n },\n \"reseller_org\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"mcc\": \"\",\n \"iso_code\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n },\n \"endpoint\": {\n \"id\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"model\": {\n \"id\": \"\",\n \"description\": \"\",\n \"memory_size\": \"\",\n \"formfactor\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"manufacturer\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-dc6b8eba-db53-4d77-88a6-1319436f2dd7" }, { "id": "33f66e80-e0c2-4331-9eb1-d102ff5c9481", "name": "Could not register the given batch. Reasons may be:\n* Could find no batch with that BIC\n* Batch already registered\n* Batch contains SIMs registered to other organisations\n* Attempted to register to `Factory Test` status when it is disabled in tariff plan\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"sim_status\": {\n \"id\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sim_batch/bic/:bic", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sim_batch", "bic", ":bic" ], "variable": [ { "key": "bic" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-33f66e80-e0c2-4331-9eb1-d102ff5c9481" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-4331dec2-f9fa-4f8d-b1fe-2b6403c8b2a2" } ], "id": "1cbe02ed-44d7-4558-b41d-b4ec691f113b", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1cbe02ed-44d7-4558-b41d-b4ec691f113b" } ], "id": "b6146e8e-3972-41a1-9823-0f9c14d20b26", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b6146e8e-3972-41a1-9823-0f9c14d20b26" } ], "id": "188053ad-7c42-46f2-956e-8ffddbeeba69", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-188053ad-7c42-46f2-956e-8ffddbeeba69" }, { "name": "stats", "item": [ { "name": "daily", "item": [ { "name": "Organization usage and costs statistics per day for the current month", "id": "2244baa4-e7c6-4958-91aa-5f799c2d7280", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stats/daily", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stats", "daily" ] }, "description": "Retrieve usage and costs statistics for the currently logged in organization and all child organizations, accumulated per days from beginning of the month until today.\n\n\n Data traffic costs aren't returned for enterprise organizations with inclusive volume.\n\n" }, "response": [ { "id": "585af488-b7dc-4a8c-9ea6-69f6bcc076a7", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/stats/daily", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stats", "daily" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-585af488-b7dc-4a8c-9ea6-69f6bcc076a7" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2244baa4-e7c6-4958-91aa-5f799c2d7280" } ], "id": "6f9e8433-24ed-4b2b-be34-177d60bf2f99", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6f9e8433-24ed-4b2b-be34-177d60bf2f99" } ], "id": "54c34588-8c51-4702-84ee-ed2b18496fe5", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-54c34588-8c51-4702-84ee-ed2b18496fe5" }, { "name": "tariff_plan", "item": [ { "name": "active", "item": [ { "name": "Retrieve your organization's active tariff plan", "id": "27d31ddc-2072-4431-bcfc-8715fd9d9042", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_plan/active", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_plan", "active" ] }, "description": "Retrieve detailed information about your organization's assigned `tariff_plan`.\n\n\n The `applied_price` field is calculated based on the active SIM cards for the current month.\n\n" }, "response": [ { "id": "cea4353d-ec36-4d89-b136-006ae5d6f879", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_plan/active", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_plan", "active" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"organisation_id\": \"\",\n \"start_date\": \"\",\n \"expiry_date\": \"\",\n \"sim_activated_rate\": \"\",\n \"sim_activated_idle_rate\": \"\",\n \"sim_suspended_rate\": \"\",\n \"sim_suspended_active_rate\": \"\",\n \"sim_activated_amount\": \"\",\n \"applied_price\": {\n \"sim_activated_rate\": [\n {\n \"scale_start\": \"\",\n \"rate\": \"\",\n \"volume\": \"\"\n },\n {\n \"scale_start\": \"\",\n \"rate\": \"\",\n \"volume\": \"\"\n }\n ]\n },\n \"tariff_plan\": {\n \"name\": \"\",\n \"description\": \"\",\n \"creation_date\": \"\",\n \"activation_date\": \"\",\n \"deprecation_date\": \"\",\n \"rate\": \"\",\n \"yearly_rate\": \"\",\n \"sim_activation_fee\": \"\",\n \"max_active_sims\": \"\",\n \"add_active_sims_rate\": \"\",\n \"add_active_sim_batch\": \"\",\n \"max_service_profiles\": \"\",\n \"max_tariff_profiles\": \"\",\n \"max_users\": \"\",\n \"minimum_runtime\": \"\",\n \"api_access_allowed\": \"\",\n \"vpn_access\": \"\",\n \"evaluation\": \"\",\n \"expiry_time\": \"\",\n \"used_count\": \"\",\n \"id\": \"\",\n \"price\": {\n \"sim_activated_rate\": [\n {\n \"scale_start\": \"\",\n \"rate\": \"\"\n },\n {\n \"scale_start\": \"\",\n \"rate\": \"\"\n }\n ]\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n },\n \"workspaces_enabled\": \"\"\n },\n \"tariff_plan_runtime\": {\n \"number_of_units\": \"\",\n \"time_unit_id\": \"\",\n \"id\": \"\"\n },\n \"active\": \"\",\n \"applied_rate\": \"\",\n \"id\": \"\",\n \"service_level\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"workspaces_enabled\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cea4353d-ec36-4d89-b136-006ae5d6f879" }, { "id": "1cc195b7-f5ad-4a1d-9a75-380a779dafe2", "name": "Organization not found or there's no active tariff plan", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_plan/active", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_plan", "active" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1cc195b7-f5ad-4a1d-9a75-380a779dafe2" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-27d31ddc-2072-4431-bcfc-8715fd9d9042" } ], "id": "0a357583-513f-4711-9963-23098e390e3f", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0a357583-513f-4711-9963-23098e390e3f" } ], "id": "276bde7c-ff41-47f7-975d-5855c4421cac", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-276bde7c-ff41-47f7-975d-5855c4421cac" }, { "name": "tariff_profile", "item": [ { "name": "{tariff_profile_id}", "item": [ { "name": "coverage", "item": [ { "name": "List tariff profile coverage", "id": "0d45a73f-6f72-4ff6-b99b-d044f2364453", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id/coverage", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id", "coverage" ], "variable": [ { "id": "ad650fac-11a2-4a51-9d08-a90f20508e7a", "key": "tariff_profile_id", "value": "", "description": "(Required) tariff profile ID" } ] }, "description": "Provides the list of countries where that tariff profile can be used." }, "response": [ { "id": "ae54065e-3ad4-4512-a44c-d8da3b9fa54e", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id/coverage", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id", "coverage" ], "variable": [ { "key": "tariff_profile_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"country\": {},\n \"redundancy_count\": \"\"\n },\n {\n \"country\": {},\n \"redundancy_count\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ae54065e-3ad4-4512-a44c-d8da3b9fa54e" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0d45a73f-6f72-4ff6-b99b-d044f2364453" } ], "id": "6f6434aa-ddc9-4414-8239-7058e82d0f7f", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6f6434aa-ddc9-4414-8239-7058e82d0f7f" }, { "name": "inclusive_volume", "item": [ { "name": "{inclusive_volume_id}", "item": [ { "name": "Assign inclusive volume to tarriff profile", "id": "ae1c0885-3fda-4264-9cce-ff8086090b06", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id/inclusive_volume/:inclusive_volume_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id", "inclusive_volume", ":inclusive_volume_id" ], "variable": [ { "id": "8f891018-efbb-4e2e-86fe-67856f96df73", "key": "tariff_profile_id", "value": "", "description": "(Required) " }, { "id": "93d16661-56fb-4f24-877e-fef749b30165", "key": "inclusive_volume_id", "value": "", "description": "(Required) " } ] }, "description": "Assignes an inclusive volume to the selected tariff profile.\nIf no inclusive volume is assigned and the customer has multiple active inclusive volumes, the traffic for this tariff profile will be rated as \"Pay As You Go\".\n\nThe selected inclusive volume must not be expired and the tariff profile should not have an inclusive volume assigned yet.\nThe tariff of the tariff profile and the inclusive volume ratezone have to match.\n" }, "response": [ { "id": "94cea7ea-b33d-4786-b44c-d1b2d448060e", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id/inclusive_volume/:inclusive_volume_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id", "inclusive_volume", ":inclusive_volume_id" ], "variable": [ { "key": "tariff_profile_id" }, { "key": "inclusive_volume_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-94cea7ea-b33d-4786-b44c-d1b2d448060e" }, { "id": "b3b696c2-19b0-4518-b171-58006db3f963", "name": "The inclusive volume is expired or tariff does not match", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id/inclusive_volume/:inclusive_volume_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id", "inclusive_volume", ":inclusive_volume_id" ], "variable": [ { "key": "tariff_profile_id" }, { "key": "inclusive_volume_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b3b696c2-19b0-4518-b171-58006db3f963" }, { "id": "4ed9af6d-7c89-4730-a597-526d0cb6c790", "name": "Tariff profile or inclusive volume not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id/inclusive_volume/:inclusive_volume_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id", "inclusive_volume", ":inclusive_volume_id" ], "variable": [ { "key": "tariff_profile_id" }, { "key": "inclusive_volume_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-4ed9af6d-7c89-4730-a597-526d0cb6c790" }, { "id": "5f533ea0-a30e-418f-8c01-226d3632c048", "name": "Tariff profile already has an inclusive volume assigned", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id/inclusive_volume/:inclusive_volume_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id", "inclusive_volume", ":inclusive_volume_id" ], "variable": [ { "key": "tariff_profile_id" }, { "key": "inclusive_volume_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5f533ea0-a30e-418f-8c01-226d3632c048" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ae1c0885-3fda-4264-9cce-ff8086090b06" }, { "name": "Unassign inclusive volume from tariff profile", "id": "3444bcdb-da13-4c43-86d4-9ae6c7d67310", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id/inclusive_volume/:inclusive_volume_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id", "inclusive_volume", ":inclusive_volume_id" ], "variable": [ { "id": "656d6484-4cb7-49bf-ab00-b30c9bb42bb2", "key": "tariff_profile_id", "value": "", "description": "(Required) " }, { "id": "44f13510-45e5-48d8-82c2-f98033d8fffa", "key": "inclusive_volume_id", "value": "", "description": "(Required) " } ] }, "description": "Unassign the inclusive volume from the selected tariff profile. If the customer has multiple active inclusive volume, the traffic within that tariff profile\nwill be rated as \"Pay As You Go\" afterwards.\n" }, "response": [ { "id": "0ea58dea-d68a-486b-8212-02e3fe9fe4ab", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id/inclusive_volume/:inclusive_volume_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id", "inclusive_volume", ":inclusive_volume_id" ], "variable": [ { "key": "tariff_profile_id" }, { "key": "inclusive_volume_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0ea58dea-d68a-486b-8212-02e3fe9fe4ab" }, { "id": "2b3bd22b-82d1-4a6a-a890-1ab8c5479056", "name": "The inclusive volume is not assigned to the selected tariff profile", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id/inclusive_volume/:inclusive_volume_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id", "inclusive_volume", ":inclusive_volume_id" ], "variable": [ { "key": "tariff_profile_id" }, { "key": "inclusive_volume_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2b3bd22b-82d1-4a6a-a890-1ab8c5479056" }, { "id": "413478ae-a441-460d-8a76-c00192eb0183", "name": "Tariff profile or inclusive volume not found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id/inclusive_volume/:inclusive_volume_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id", "inclusive_volume", ":inclusive_volume_id" ], "variable": [ { "key": "tariff_profile_id" }, { "key": "inclusive_volume_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-413478ae-a441-460d-8a76-c00192eb0183" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3444bcdb-da13-4c43-86d4-9ae6c7d67310" } ], "id": "cbead6a7-56ec-402c-a6f6-60548ba818a7", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cbead6a7-56ec-402c-a6f6-60548ba818a7" } ], "id": "c755ff65-4084-429e-909b-4679001e3296", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c755ff65-4084-429e-909b-4679001e3296" }, { "name": "ratezone_selection", "item": [ { "name": "{ratezone_id}", "item": [ { "name": "Assign ratezone to tarriff profile", "id": "3806905f-b05e-4a3a-93e8-a2f13a2dcc38", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id/ratezone_selection/:ratezone_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id", "ratezone_selection", ":ratezone_id" ], "variable": [ { "id": "e470b394-8dbf-4fba-9862-9b588abfef6f", "key": "tariff_profile_id", "value": "", "description": "(Required) " }, { "id": "1e7355df-2958-41a5-867d-7054d2e5f394", "key": "ratezone_id", "value": "", "description": "(Required) " } ] }, "description": "Only currently valid and active ratezones can be selected for a tariff profile" }, "response": [ { "id": "781aa8d6-0a83-4b83-aa48-d329da265afd", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id/ratezone_selection/:ratezone_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id", "ratezone_selection", ":ratezone_id" ], "variable": [ { "key": "tariff_profile_id" }, { "key": "ratezone_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-781aa8d6-0a83-4b83-aa48-d329da265afd" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3806905f-b05e-4a3a-93e8-a2f13a2dcc38" }, { "name": "Delete ratezone from tariff profile", "id": "6d63f5c2-e1d3-4b5b-8d1d-06ec18bb7b2c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id/ratezone_selection/:ratezone_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id", "ratezone_selection", ":ratezone_id" ], "variable": [ { "id": "99f40336-89d5-42f8-ac09-be0eee8722f1", "key": "tariff_profile_id", "value": "", "description": "(Required) " }, { "id": "b0a07392-4b56-4d4c-997c-0b5b1c2cbf6b", "key": "ratezone_id", "value": "", "description": "(Required) " } ] }, "description": "Remove previously selected ratezones from a tariff profile" }, "response": [ { "id": "42483c07-9265-48fd-9346-789d3aa772c7", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id/ratezone_selection/:ratezone_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id", "ratezone_selection", ":ratezone_id" ], "variable": [ { "key": "tariff_profile_id" }, { "key": "ratezone_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-42483c07-9265-48fd-9346-789d3aa772c7" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6d63f5c2-e1d3-4b5b-8d1d-06ec18bb7b2c" } ], "id": "4ff1291e-3f30-4b3d-8b48-419b8c51d626", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-4ff1291e-3f30-4b3d-8b48-419b8c51d626" } ], "id": "a45200b7-28b5-4c3b-8917-08656117759c", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a45200b7-28b5-4c3b-8917-08656117759c" }, { "name": "Tariff profile details", "id": "db4224aa-2bea-4b20-9b8e-e60726cdaf82", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id" ], "variable": [ { "id": "306260f7-c09e-4f59-9222-81030b7a111a", "key": "tariff_profile_id", "value": "", "description": "(Required) " } ] }, "description": "Returns tariff profile specified by id. This tariff profile also contains information about the currently valid ratezones of the tariff in the tariff profile and if the ratezone is selected in the tariff profile.\nIt also contains applied custom rates for the included tariffs.\n" }, "response": [ { "id": "b864e239-90b8-4a4e-a10e-846a6c15f7e1", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id" ], "variable": [ { "key": "tariff_profile_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"used_count\": \"\",\n \"organisation_id\": \"\",\n \"tariff\": {\n \"id\": \"\",\n \"organisation_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"tariff_status_id\": \"\",\n \"currency_id\": \"\",\n \"default_sms_mt_rate\": \"\",\n \"default_sms_mo_rate\": \"\",\n \"sim_issued_rate\": \"\",\n \"sim_activated_rate\": \"\",\n \"sim_suspended_rate\": \"\",\n \"sim_activation_rate\": \"\",\n \"sim_reactivation_rate\": \"\",\n \"sim_suspension_rate\": \"\",\n \"sim_termination_rate\": \"\",\n \"data_throttle_id\": \"\",\n \"data_blocksize_id\": \"\",\n \"public\": \"\",\n \"tariff_category_id\": \"\",\n \"visibility_id\": \"\",\n \"tariff_currency_category_id\": \"\",\n \"used_count\": \"\",\n \"assigned_count\": \"\",\n \"currency\": {\n \"id\": {},\n \"code\": \"\",\n \"symbol\": \"\"\n }\n },\n \"inclusive_volume\": {\n \"id\": \"\",\n \"volume\": \"\",\n \"rate\": \"\",\n \"pooled\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"ratezone\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currency\": {\n \"id\": \"\",\n \"code\": \"\",\n \"symbol\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b864e239-90b8-4a4e-a10e-846a6c15f7e1" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-db4224aa-2bea-4b20-9b8e-e60726cdaf82" }, { "name": "Delete tariff profile", "id": "6437328b-5348-4be0-9c10-1c8b9f95e10a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id" ], "variable": [ { "id": "50e7434f-f4b6-4767-900b-0033196d9e23", "key": "tariff_profile_id", "value": "", "description": "(Required) " } ] }, "description": "Deletes tariff profile. Tariff profiles used by an endpoint (`used_count` > 0) cannot be deleted." }, "response": [ { "id": "1a89a54f-e50d-4fa8-a01c-ff61bc46a410", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id" ], "variable": [ { "key": "tariff_profile_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1a89a54f-e50d-4fa8-a01c-ff61bc46a410" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6437328b-5348-4be0-9c10-1c8b9f95e10a" }, { "name": "Update tariff profile", "id": "02c785d9-0758-4be2-bcc6-176199299d06", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"tariff\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id" ], "variable": [ { "id": "540af06d-d4a3-4f82-92b3-3f6564838a8d", "key": "tariff_profile_id", "value": "", "description": "(Required) " } ] }, "description": "Patch the specified tariff profile.\n\n\n The API doesn't provide feedback if you assign an incompatible tariff profile to a SIM.\n See [Tariff profile](/developers/reference/tariff-profile) for more information.\n\n\nYou can provide following fields with this request:\n\n* `name` (String optional)\n* `description` (String optional)\n* `tariff` (Object optional) If the tariff is changed, all selections of ratezones are removed.\n" }, "response": [ { "id": "0db59da9-b07a-4fb0-a202-2ab529b42e45", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"tariff\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile/:tariff_profile_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile", ":tariff_profile_id" ], "variable": [ { "key": "tariff_profile_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0db59da9-b07a-4fb0-a202-2ab529b42e45" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-02c785d9-0758-4be2-bcc6-176199299d06" } ], "id": "2a551ee6-a734-403b-b85a-33ca283af6af", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2a551ee6-a734-403b-b85a-33ca283af6af" }, { "name": "List tariff profiles", "id": "3f951d11-df3c-4aa2-a4fa-3a4a093a17e6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile" ] }, "description": "Returns the list of tariff profiles of the user's own organisation." }, "response": [ { "id": "47e4e502-7f6d-4d30-8ebb-d407e5a2b11c", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"used_count\": \"\",\n \"organisation_id\": \"\",\n \"tariff\": {\n \"id\": \"\",\n \"organisation_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"tariff_status_id\": \"\",\n \"currency_id\": \"\",\n \"default_sms_mt_rate\": \"\",\n \"default_sms_mo_rate\": \"\",\n \"sim_issued_rate\": \"\",\n \"sim_activated_rate\": \"\",\n \"sim_suspended_rate\": \"\",\n \"sim_activation_rate\": \"\",\n \"sim_reactivation_rate\": \"\",\n \"sim_suspension_rate\": \"\",\n \"sim_termination_rate\": \"\",\n \"data_throttle_id\": \"\",\n \"data_blocksize_id\": \"\",\n \"public\": \"\",\n \"tariff_category_id\": \"\",\n \"visibility_id\": \"\",\n \"tariff_currency_category_id\": \"\",\n \"used_count\": \"\",\n \"assigned_count\": \"\",\n \"currency\": {\n \"id\": {},\n \"code\": \"\",\n \"symbol\": \"\"\n }\n },\n \"inclusive_volume\": {\n \"id\": \"\",\n \"volume\": \"\",\n \"rate\": \"\",\n \"pooled\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"ratezone\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currency\": {\n \"id\": \"\",\n \"code\": \"\",\n \"symbol\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"used_count\": \"\",\n \"organisation_id\": \"\",\n \"tariff\": {\n \"id\": \"\",\n \"organisation_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"tariff_status_id\": \"\",\n \"currency_id\": \"\",\n \"default_sms_mt_rate\": \"\",\n \"default_sms_mo_rate\": \"\",\n \"sim_issued_rate\": \"\",\n \"sim_activated_rate\": \"\",\n \"sim_suspended_rate\": \"\",\n \"sim_activation_rate\": \"\",\n \"sim_reactivation_rate\": \"\",\n \"sim_suspension_rate\": \"\",\n \"sim_termination_rate\": \"\",\n \"data_throttle_id\": \"\",\n \"data_blocksize_id\": \"\",\n \"public\": \"\",\n \"tariff_category_id\": \"\",\n \"visibility_id\": \"\",\n \"tariff_currency_category_id\": \"\",\n \"used_count\": \"\",\n \"assigned_count\": \"\",\n \"currency\": {\n \"id\": {},\n \"code\": \"\",\n \"symbol\": \"\"\n }\n },\n \"inclusive_volume\": {\n \"id\": \"\",\n \"volume\": \"\",\n \"rate\": \"\",\n \"pooled\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"ratezone\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currency\": {\n \"id\": \"\",\n \"code\": \"\",\n \"symbol\": \"\"\n }\n }\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-47e4e502-7f6d-4d30-8ebb-d407e5a2b11c" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3f951d11-df3c-4aa2-a4fa-3a4a093a17e6" }, { "name": "Create tariff profile", "id": "64e7c2fb-e89d-4b41-ae68-b774266c5976", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"tariff\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile" ] }, "description": "Create the specified tariff profile\nID must not be specified, neither in query String, nor in JSON payload.\nYou can provide following fields with this request:\n\n* `name` (String required)\n* `description` (String optional)\n* `tariff` (Object required)\n" }, "response": [ { "id": "a6d13625-8d47-492f-a813-d82063cc3656", "name": "Resource Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"tariff\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tariff_profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tariff_profile" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a6d13625-8d47-492f-a813-d82063cc3656" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-64e7c2fb-e89d-4b41-ae68-b774266c5976" } ], "id": "801917f6-b20b-4fca-a48b-d7f6d9736500", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-801917f6-b20b-4fca-a48b-d7f6d9736500" }, { "name": "traffic_limit", "item": [ { "name": "List traffic limits", "id": "a5ad8b52-9ea8-4e1d-ac90-0050f448a493", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/traffic_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "traffic_limit" ] }, "description": "Retrieves a list of available traffic limits." }, "response": [ { "id": "b8c3f05c-2a69-402d-aac6-4c3882a52987", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/traffic_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "traffic_limit" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"service\": {},\n \"volume\": \"\",\n \"period\": {}\n },\n {\n \"id\": \"\",\n \"service\": {},\n \"volume\": \"\",\n \"period\": {}\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b8c3f05c-2a69-402d-aac6-4c3882a52987" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a5ad8b52-9ea8-4e1d-ac90-0050f448a493" } ], "id": "a1e608bd-879e-4a5f-a0ac-689062162910", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a1e608bd-879e-4a5f-a0ac-689062162910" }, { "name": "user", "item": [ { "name": "activation", "item": [ { "name": "Activate user", "id": "3a871fcf-fef0-4bbf-be97-ce86824a8412", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"activationKey\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user/activation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "activation" ] }, "description": "Activates the user account and sets a password.\nThe activation key is sent via email.\n\n\n This is a public (unauthenticated) service which ignores auth tokens.\n\n" }, "response": [ { "id": "714132ef-5f84-4984-90f8-d6728af9517b", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"activationKey\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user/activation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "activation" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-714132ef-5f84-4984-90f8-d6728af9517b" }, { "id": "84eec7c4-a057-44dc-9571-56ec1130b6c4", "name": "response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"activationKey\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user/activation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "activation" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-84eec7c4-a057-44dc-9571-56ec1130b6c4" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3a871fcf-fef0-4bbf-be97-ce86824a8412" } ], "id": "e4699a20-2b94-44fe-8071-cd9cf258b9a0", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e4699a20-2b94-44fe-8071-cd9cf258b9a0" }, { "name": "activation_resend", "item": [ { "name": "Resend user activation email", "id": "247cdd75-173e-4446-8e53-2a330cf0cf13", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"g-recaptcha-response\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user/activation_resend", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "activation_resend" ] }, "description": "Re-sends activation mail to the user.\n\nAs this endpoint is open to the public (no authentication token necessary), it requires instead the google reCAPTCHA token to ensure that no robot is performing the request.\nMoreover, there's a time limit on how often a given user may be issued with a new activation mail.\n\n\n According to the [reCAPTCHA documentation](https://developers.google.com/recaptcha/docs/display) a \"Site Key\" is necessary.\n If you want to implement this feature in your client, please contact emnify support to obtain this \"Site Key\" for your domain.\n\n" }, "response": [ { "id": "3898537c-aa43-4fa6-9d30-4725b08562ca", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"g-recaptcha-response\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user/activation_resend", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "activation_resend" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3898537c-aa43-4fa6-9d30-4725b08562ca" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-247cdd75-173e-4446-8e53-2a330cf0cf13" } ], "id": "7795164c-e697-42c3-9fc3-a90917fe6d26", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7795164c-e697-42c3-9fc3-a90917fe6d26" }, { "name": "mfa", "item": [ { "name": "status", "item": [ { "name": "List MFA key statuses", "id": "48936951-880a-4296-8eb0-e22055e216bd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/user/mfa/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "mfa", "status" ] }, "description": "Retrieve a list of possible MFA Key statuses." }, "response": [ { "id": "5ad04f3f-ad4c-48ab-9407-9507599ed8e2", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/mfa/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "mfa", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5ad04f3f-ad4c-48ab-9407-9507599ed8e2" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-48936951-880a-4296-8eb0-e22055e216bd" } ], "id": "28886508-a2ec-4a80-9356-b9f365be7926", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-28886508-a2ec-4a80-9356-b9f365be7926" }, { "name": "type", "item": [ { "name": "List MFA key types", "id": "0aa43e82-d602-4cee-bca7-e3bc692528ea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/user/mfa/type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "mfa", "type" ] }, "description": "Retrieve a list of possible MFA Key types." }, "response": [ { "id": "c712052a-2f0a-4877-a204-e61cf4dda93f", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/mfa/type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "mfa", "type" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c712052a-2f0a-4877-a204-e61cf4dda93f" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0aa43e82-d602-4cee-bca7-e3bc692528ea" } ], "id": "f424209c-66cf-427b-890b-41f1df45f30f", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f424209c-66cf-427b-890b-41f1df45f30f" }, { "name": "{key_id}", "item": [ { "name": "Activate MFA key", "id": "696cab73-d750-4edc-9513-28a4141386b6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": {\n \"id\": \"\"\n },\n \"code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user/mfa/:key_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "mfa", ":key_id" ], "variable": [ { "id": "219079fe-9e25-4b84-a247-d4640eb99f24", "key": "key_id", "value": "", "description": "(Required) The unique identifier of the MFA key to activate.\nThis ID is returned when you [create the MFA key](/developers/api/authentication/post-mfa).\n" } ] }, "description": "Activates a pending MFA key for the authenticated user.\n\nAfter you [create an MFA key](/developers/api/authentication/post-mfa), the key has status `Activation Pending`.\nTo complete setup, call this endpoint with the MFA key ID and a valid 6-digit time-based one-time password (TOTP) generated from the `secret_key` or `otpauth` URI returned during creation.\n\nOnce activated, the MFA key status changes to `Active`, and MFA is enforced on subsequent logins with [user credentials](/developers/auth/user-credentials).\n\nFor more information, see [Multi-factor authentication](/developers/auth/multi-factor-authentication).\n" }, "response": [ { "id": "b8a575db-152c-455f-bc27-cd52cd4ad604", "name": "MFA key activated successfully. No content returned.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"status\": {\n \"id\": \"\"\n },\n \"code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user/mfa/:key_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "mfa", ":key_id" ], "variable": [ { "key": "key_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b8a575db-152c-455f-bc27-cd52cd4ad604" }, { "id": "819c0836-e35d-478b-a54a-967a7cc8e851", "name": "MFA key not found.\nVerify the `key_id` is correct and belongs to the authenticated user.\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"status\": {\n \"id\": \"\"\n },\n \"code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user/mfa/:key_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "mfa", ":key_id" ], "variable": [ { "key": "key_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-819c0836-e35d-478b-a54a-967a7cc8e851" }, { "id": "d4de5ebe-d5b1-4575-9833-9881e46b45b7", "name": "MFA key is already activated.\nEach key can only be activated once.\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"status\": {\n \"id\": \"\"\n },\n \"code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user/mfa/:key_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "mfa", ":key_id" ], "variable": [ { "key": "key_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d4de5ebe-d5b1-4575-9833-9881e46b45b7" }, { "id": "e6a4c06f-5de6-4732-9374-6c945947b89d", "name": "Invalid TOTP code.\nThe code didn't match the expected value.\nThis can happen if:\n\n- The code was entered incorrectly\n- The code expired (codes are valid for 30 seconds)\n- The device clock is out of sync with the server\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"status\": {\n \"id\": \"\"\n },\n \"code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user/mfa/:key_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "mfa", ":key_id" ], "variable": [ { "key": "key_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e6a4c06f-5de6-4732-9374-6c945947b89d" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-696cab73-d750-4edc-9513-28a4141386b6" } ], "id": "7cc74850-c38f-4f9d-bece-b8e80d81c1d1", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7cc74850-c38f-4f9d-bece-b8e80d81c1d1" }, { "name": "Create an MFA key", "id": "b3894353-8dde-4e5a-b8f4-ee6138e3873f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": {},\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user/mfa", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "mfa" ] }, "description": "Generate and store a MFA key for the requesting user. After this call, the MFA key has the status `activation pending` and must be activated through a separate call (`/api/v1/user/mfa/{id}`).\n\nYou must provide following fields with this request:\n\n* `type` (Object required)\n - `id` (Number)\n* `password` (String required) - User password\n\nThe **MFA key** object returned by the server contains the following properties:\n\n* `id` (Integer) - The unique ID of this MFA key\n* `status` (Object) ID (Integer) - Id of status of this MFA key\n - `description` (String) - description of the status\n* `type` (Object) ID (Integer) - Id of type of this MFA key\n - `description` (String) - description of the type\n* `secret_key` (String) - Secret key (encoded in Base32) for this MFA key, will be displayed only on creation\n* `otpauth` (String) - Secret key as a URI encoded for QR codes, will be displayed only on creation\n* `creation_date` (Timestamp) - Timestamp when this MFA key was created - type: ISO 8601 timestamp format\n* `activation_date` (Timestamp) - Timestamp when this MFA key was activated - type: ISO 8601 timestamp format\n" }, "response": [ { "id": "97e68c85-e688-42f4-a08a-e52bcde0a437", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": {},\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user/mfa", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "mfa" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"type\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"secret_key\": \"\",\n \"otpauth\": \"\",\n \"creation_date\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-97e68c85-e688-42f4-a08a-e52bcde0a437" }, { "id": "55def278-9044-4934-972f-7ffc6ee7de6d", "name": "Unexpected error in API call.\nSee HTTP response body for details.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": {},\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user/mfa", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "mfa" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-55def278-9044-4934-972f-7ffc6ee7de6d" }, { "id": "301c0115-28c1-4833-9273-1b40be25173e", "name": "Unprocessable Entity.\nSee HTTP response body for details.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": {},\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user/mfa", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "mfa" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-301c0115-28c1-4833-9273-1b40be25173e" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b3894353-8dde-4e5a-b8f4-ee6138e3873f" } ], "id": "18c387de-3a36-4bed-9c0e-bba0376c1ab2", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-18c387de-3a36-4bed-9c0e-bba0376c1ab2" }, { "name": "password", "item": [ { "name": "Change password", "id": "da859092-7777-45da-8b06-b44eef62a0e6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"old_password\": \"\",\n \"new_password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user/password", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "password" ] }, "description": "Changes the password for the currently authenticated user.\n\n\n The client application should invalidate the authentication token.\n\n" }, "response": [ { "id": "c53e4c57-42ac-4742-b9d1-8d7fe7e9a2bc", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"old_password\": \"\",\n \"new_password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user/password", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "password" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c53e4c57-42ac-4742-b9d1-8d7fe7e9a2bc" }, { "id": "dce76487-efdb-447d-91f3-f104fc8d743b", "name": "See HTTP response body for details.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"old_password\": \"\",\n \"new_password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user/password", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "password" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-dce76487-efdb-447d-91f3-f104fc8d743b" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-da859092-7777-45da-8b06-b44eef62a0e6" } ], "id": "9f646a5a-a7aa-44a7-9899-17252684bac0", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9f646a5a-a7aa-44a7-9899-17252684bac0" }, { "name": "role", "item": [ { "name": "List user roles", "id": "27f2eec6-7436-41a6-8fd5-bcf5d8cfb035", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/user/role", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "role" ] }, "description": "Retrieves the collection of available user roles" }, "response": [ { "id": "85f7712b-8f5c-4910-ac57-e01ef976ad58", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/role", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "role" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-85f7712b-8f5c-4910-ac57-e01ef976ad58" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-27f2eec6-7436-41a6-8fd5-bcf5d8cfb035" } ], "id": "03ad7480-84f9-4bf4-a518-eacd5ad76677", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-03ad7480-84f9-4bf4-a518-eacd5ad76677" }, { "name": "status", "item": [ { "name": "List user statuses", "id": "81c080d0-3e71-419f-8b18-1205f927770f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/user/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "status" ] }, "description": "Provides the list of available user status (lookup)." }, "response": [ { "id": "38022538-979e-49ab-a671-732133524347", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-38022538-979e-49ab-a671-732133524347" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-81c080d0-3e71-419f-8b18-1205f927770f" } ], "id": "bbe00613-df0c-443a-a69d-04060a97f766", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-bbe00613-df0c-443a-a69d-04060a97f766" }, { "name": "{user_id}", "item": [ { "name": "event", "item": [ { "name": "List user events", "id": "263429e2-9553-4759-9dfc-a5ff5a274869", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/event?page=&per_page=&sort=&q=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "event" ], "query": [ { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "per_page", "value": "" }, { "description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n", "key": "sort", "value": "" }, { "description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n", "key": "q", "value": "" } ], "variable": [ { "id": "d1c9eafc-b15b-4afd-92a6-fc94b3c2ed50", "key": "user_id", "value": "", "description": "(Required) User ID" } ] }, "description": "Returns the list of events, filtered, sorted and paged according to query parameters.\n\nOnly an administrator or observer may be allowed to see events of other users, provided they belong to an organisation he/she has access to.\n\nAny user can retrieve their own events at `/api/v1/user/my/event`.\n\n\n This API endpoint deviates from the specified conventions and may not return the same HTTP Codes as the higher layer call (`/api/v1/user/{user_id|my}`).\n\n In case the requested `{user_id}` does not exist or is not accessible for the user, **HTTP 200** will be returned with empty **[]** as long as the provided `{user_id}` is a number and all parameters are valid.\n\n Please take that into consideration when building automation on top of the error behavior of this endpoint.\n\n" }, "response": [ { "id": "9c7f993e-feac-4a55-89d8-937ef4c72a07", "name": "Successfully returned a list of User events", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/event?page=&per_page=&sort=&q=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "event" ], "query": [ { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "per_page", "value": "" }, { "description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n", "key": "sort", "value": "" }, { "description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n", "key": "q", "value": "" } ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"alert\": \"\",\n \"description\": \"\",\n \"timestamp\": \"\",\n \"event_type\": {},\n \"event_source\": {},\n \"event_severity\": {},\n \"organisation\": {},\n \"user\": {}\n },\n {\n \"id\": \"\",\n \"alert\": \"\",\n \"description\": \"\",\n \"timestamp\": \"\",\n \"event_type\": {},\n \"event_source\": {},\n \"event_severity\": {},\n \"organisation\": {},\n \"user\": {}\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9c7f993e-feac-4a55-89d8-937ef4c72a07" }, { "id": "2b828dd2-c85c-4740-a006-5c512dfe91fe", "name": "**Bad Request** due to incorrect **Paging** Parameters, **Sorting** Parameter or incorrect `{user_id}`\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/event?page=&per_page=&sort=&q=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "event" ], "query": [ { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "per_page", "value": "" }, { "description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n", "key": "sort", "value": "" }, { "description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n", "key": "q", "value": "" } ], "variable": [ { "key": "user_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2b828dd2-c85c-4740-a006-5c512dfe91fe" }, { "id": "cea056f0-e37d-43be-a52f-b83f3bd5a559", "name": "**Forbidden** due to incorrect user role or lack of access\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/event?page=&per_page=&sort=&q=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "event" ], "query": [ { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "per_page", "value": "" }, { "description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n", "key": "sort", "value": "" }, { "description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n", "key": "q", "value": "" } ], "variable": [ { "key": "user_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cea056f0-e37d-43be-a52f-b83f3bd5a559" }, { "id": "a46f4b1a-c75b-46ec-925f-0241e5389479", "name": "**Unprocessable Entity** due to incorrect **Query** parameters\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/event?page=&per_page=&sort=&q=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "event" ], "query": [ { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "per_page", "value": "" }, { "description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n", "key": "sort", "value": "" }, { "description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n", "key": "q", "value": "" } ], "variable": [ { "key": "user_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a46f4b1a-c75b-46ec-925f-0241e5389479" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-263429e2-9553-4759-9dfc-a5ff5a274869" } ], "id": "ba715c00-c178-43cb-8ed8-85b4fac95a6c", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ba715c00-c178-43cb-8ed8-85b4fac95a6c" }, { "name": "mfa", "item": [ { "name": "trusted_device", "item": [ { "name": "{device_id}", "item": [ { "name": "Delete a trusted device", "id": "c53d6064-9da0-4da3-b881-b71eafea7b73", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/mfa/trusted_device/:device_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "mfa", "trusted_device", ":device_id" ], "variable": [ { "id": "62ba78bc-449f-41fc-b74e-8d78f41d5e97", "key": "user_id", "value": "", "description": "(Required) User ID" }, { "id": "47e8c08c-f129-49a8-91bd-b8bfe09f92a1", "key": "device_id", "value": "", "description": "(Required) Device ID" } ] }, "description": "Deletes a trusted device.\n\nRemoving one's own trusted device can also be performed at either `/api/v1/user/my/mfa/trusted_device/{id}` or `/api/v1/user/mfa/trusted_device/{id}`\n" }, "response": [ { "id": "f5ecfbf9-694a-42d2-b193-77499c505aab", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/mfa/trusted_device/:device_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "mfa", "trusted_device", ":device_id" ], "variable": [ { "key": "user_id" }, { "key": "device_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f5ecfbf9-694a-42d2-b193-77499c505aab" }, { "id": "51c7e043-aee6-47da-b799-6556922caf58", "name": "Unexpected error in API call.\nSee HTTP response body for details.\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/mfa/trusted_device/:device_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "mfa", "trusted_device", ":device_id" ], "variable": [ { "key": "user_id" }, { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-51c7e043-aee6-47da-b799-6556922caf58" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c53d6064-9da0-4da3-b881-b71eafea7b73" } ], "id": "4d87c879-1faf-41a4-8de4-1e5a5c979ba8", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-4d87c879-1faf-41a4-8de4-1e5a5c979ba8" }, { "name": "List trusted devices", "id": "b17b8f69-69aa-451a-875b-6a51cdbad73c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/mfa/trusted_device", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "mfa", "trusted_device" ], "variable": [ { "id": "8721299a-15f8-4258-a3e9-eccda8a41d6d", "key": "user_id", "value": "", "description": "(Required) User ID" } ] }, "description": "Returns the list of trusted devices for a given user.\n\nThe list of one's own trusted devices can also be retrieved with a call to either\n`/api/v1/user/my/mfa/trusted_device` or `/api/v1/user/mfa/trusted_device`\n" }, "response": [ { "id": "3c6e04fb-755b-41b4-8149-e341dc41b767", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/mfa/trusted_device", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "mfa", "trusted_device" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"operating_system\": \"\",\n \"browser\": \"\",\n \"activation_date\": \"\"\n },\n {\n \"id\": \"\",\n \"operating_system\": \"\",\n \"browser\": \"\",\n \"activation_date\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3c6e04fb-755b-41b4-8149-e341dc41b767" }, { "id": "8b095b27-d5b2-4acc-ab4a-c73f2ba605e0", "name": "Unexpected error in API call.\nSee HTTP response body for details.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/mfa/trusted_device", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "mfa", "trusted_device" ], "variable": [ { "key": "user_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8b095b27-d5b2-4acc-ab4a-c73f2ba605e0" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b17b8f69-69aa-451a-875b-6a51cdbad73c" } ], "id": "da533a64-01fb-4f8a-b64f-7d714646692b", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-da533a64-01fb-4f8a-b64f-7d714646692b" }, { "name": "{key_id}", "item": [ { "name": "Delete an MFA key", "id": "a4404cfe-43f0-4eeb-9be6-6fba5d70095a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/mfa/:key_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "mfa", ":key_id" ], "variable": [ { "id": "50de6760-dc39-4065-99a6-ff36b24af7d3", "key": "user_id", "value": "", "description": "(Required) User ID" }, { "id": "51eb34ab-cdd7-4da3-ac30-23be63698aef", "key": "key_id", "value": "", "description": "(Required) Key ID" } ] }, "description": "Delete an MFA key for a given user.\n\nAn own MFA key can also be deleted with a call to `/api/v1/user/my/mfa/{key_id}`\n" }, "response": [ { "id": "821c0bf7-0415-4544-8ef7-4f13a725ec94", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/mfa/:key_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "mfa", ":key_id" ], "variable": [ { "key": "user_id" }, { "key": "key_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-821c0bf7-0415-4544-8ef7-4f13a725ec94" }, { "id": "b7ac2d5b-c041-4153-96db-0b75182313b4", "name": "Unexpected error in API call.\nSee HTTP response body for details.\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/mfa/:key_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "mfa", ":key_id" ], "variable": [ { "key": "user_id" }, { "key": "key_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b7ac2d5b-c041-4153-96db-0b75182313b4" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a4404cfe-43f0-4eeb-9be6-6fba5d70095a" } ], "id": "404352a7-12da-4f7d-9bcd-a3246dbeb623", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-404352a7-12da-4f7d-9bcd-a3246dbeb623" } ], "id": "cb1d6cf4-48a6-4198-bf6a-57ec25504c08", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cb1d6cf4-48a6-4198-bf6a-57ec25504c08" }, { "name": "role", "item": [ { "name": "permission", "item": [ { "name": "List user role permissions", "id": "42c9c4b1-f942-4dd9-abac-bfb5df21a591", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/role/permission", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "role", "permission" ], "variable": [ { "id": "ca4abb79-3547-469e-93b9-7f05eb6c0434", "key": "user_id", "value": "", "description": "(Required) User ID" } ] }, "description": "Role permissions available to this user.\n\nOnly an administrator or observer is allowed to see the role permissions of other users, provided they belong to an organisation he/she has access to.
\n\nAny user can also retrieve one's own role permissions at:\n`/api/v1/user/my/role/permission`.\n" }, "response": [ { "id": "e2450ddd-9e72-42b7-afa5-2cc725b31fcc", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/role/permission", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "role", "permission" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e2450ddd-9e72-42b7-afa5-2cc725b31fcc" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-42c9c4b1-f942-4dd9-abac-bfb5df21a591" } ], "id": "553ad1cc-b6bf-4405-ab81-a3d5f0a9c7c0", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-553ad1cc-b6bf-4405-ab81-a3d5f0a9c7c0" }, { "name": "{role_id}", "item": [ { "name": "Assign role to user", "id": "26aba6f9-df8b-42db-a6ce-f1d6fe8c55ef", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/role/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "role", ":role_id" ], "variable": [ { "id": "b44556f3-feea-425b-bddc-45b5136a84de", "key": "user_id", "value": "", "description": "(Required) " }, { "id": "87f8f683-2780-4b87-ac33-95733f7f9f04", "key": "role_id", "value": "", "description": "(Required) " } ] }, "description": "Role is assigned to this user." }, "response": [ { "id": "60734979-b9f0-476c-a34d-fbbde9db64bf", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/role/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "role", ":role_id" ], "variable": [ { "key": "user_id" }, { "key": "role_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-60734979-b9f0-476c-a34d-fbbde9db64bf" }, { "id": "ca167b5b-1651-42d4-b59c-f4980c3b74b2", "name": "Unexpected error in API call. See HTTP response body for details.", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/role/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "role", ":role_id" ], "variable": [ { "key": "user_id" }, { "key": "role_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ca167b5b-1651-42d4-b59c-f4980c3b74b2" }, { "id": "3b35dbfb-8541-4b8f-ad98-b2225e230ca0", "name": "Unexpected error in API call. See HTTP response body for details.", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/role/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "role", ":role_id" ], "variable": [ { "key": "user_id" }, { "key": "role_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3b35dbfb-8541-4b8f-ad98-b2225e230ca0" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-26aba6f9-df8b-42db-a6ce-f1d6fe8c55ef" }, { "name": "Delete user role", "id": "fdfcfa09-17ba-49db-bddc-5387a8e00195", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/role/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "role", ":role_id" ], "variable": [ { "id": "befeb0f1-ef1d-4045-bb29-a53ee1b1bde3", "key": "user_id", "value": "", "description": "(Required) " }, { "id": "dc43c238-57c2-45a0-bcf0-6e371dfeeb1b", "key": "role_id", "value": "", "description": "(Required) " } ] }, "description": "Release a Role from association with this user.\n\n\n A role can only be removed if it's not the last role of this user.\n\n" }, "response": [ { "id": "9cbedf5e-f29a-43d8-8856-ae3939c6cb71", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/role/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "role", ":role_id" ], "variable": [ { "key": "user_id" }, { "key": "role_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9cbedf5e-f29a-43d8-8856-ae3939c6cb71" }, { "id": "b2daf9d8-6442-4eb3-abc5-30a1c17a1986", "name": "Unexpected error in API call. See HTTP response body for details.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/role/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "role", ":role_id" ], "variable": [ { "key": "user_id" }, { "key": "role_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b2daf9d8-6442-4eb3-abc5-30a1c17a1986" }, { "id": "757f8b3b-d5ae-4c35-817b-f0d4aa31fc11", "name": "Unexpected error in API call. See HTTP response body for details.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id/role/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id", "role", ":role_id" ], "variable": [ { "key": "user_id" }, { "key": "role_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-757f8b3b-d5ae-4c35-817b-f0d4aa31fc11" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-fdfcfa09-17ba-49db-bddc-5387a8e00195" } ], "id": "8ebc015e-66b5-431e-b336-606b0f01429a", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8ebc015e-66b5-431e-b336-606b0f01429a" } ], "id": "fb989380-a6de-44ad-9e2c-11c1ac6d6a4a", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-fb989380-a6de-44ad-9e2c-11c1ac6d6a4a" }, { "name": "Get user by ID or username", "id": "f4260ffe-fe28-4808-b606-158b71fbbb1e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id" ], "variable": [ { "id": "49b7a636-a49b-417e-a89d-abb6cacb7fe7", "key": "user_id", "value": "", "description": "(Required) User ID" } ] }, "description": "Get a specific user by ID provided the user is within this requesting user's organisation or the organisation's immediate child organisations.\n\n`id` may be one of:\n\n* The numeric ID of the user, e.g. \"123\". This is the top-level `id` object returned by each item in `GET /api/v1/user`\n* Username (email), e.g. \"exampleuser@org.de\". This is the top-level `username` object returned by each item in `GET /api/v1/user`\n" }, "response": [ { "id": "fadb3824-95bc-443a-82cb-ae3f2e43ea4d", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"username\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"status\": {},\n \"organisation\": {}\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-fadb3824-95bc-443a-82cb-ae3f2e43ea4d" }, { "id": "ba4d393a-2fab-4f94-8690-8116b80dec9d", "name": "Unexpected error in API call. See HTTP response body for details.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ba4d393a-2fab-4f94-8690-8116b80dec9d" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f4260ffe-fe28-4808-b606-158b71fbbb1e" }, { "name": "Delete user by ID", "id": "c676387c-8405-4428-91b0-77d5b29821a1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id" ], "variable": [ { "id": "e1668eca-bff5-48b3-955f-56f2bc43c3b6", "key": "user_id", "value": "", "description": "(Required) " } ] }, "description": "\n **This call is deprecated.**\n Please use DELETE `/api/v2/user/:id` instead.\n\n\n\n A user can be deleted, if belonging to the same organization as the requesting user, or to an organization which is a direct child of the requesting user's organization.\n\n" }, "response": [ { "id": "4c5623d5-81a0-447f-922e-c65505ccb016", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-4c5623d5-81a0-447f-922e-c65505ccb016" }, { "id": "58cb9b3e-9f2c-4dc8-9e10-6b1acc78cbc9", "name": "Unexpected error in API call. See HTTP response body for details.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-58cb9b3e-9f2c-4dc8-9e10-6b1acc78cbc9" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c676387c-8405-4428-91b0-77d5b29821a1" }, { "name": "Update user by ID", "id": "0221c993-1c8a-4491-bdb3-625bd4f5e78e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"name\": \"\",\n \"status\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id" ], "variable": [ { "id": "34fabc91-014d-42ec-8ccb-da6e34e322f9", "key": "user_id", "value": "", "description": "(Required) " } ] }, "description": "Provided fields\n* `username` (String optional) - has to be user's email\n* `name` (String optional)\n* `status` (Object optional)\n* `organisation` (Object optional) - must be the current organisation or not to be provided\n\n#### Notes\n\n* Password is not provided. Separate calls provide password management.\n* The organisation is not modifiable. A user can be updated, if belonging to the same organisation as the requesting user,\nor to an organisation which is a direct child of the requesting user's organisation.\n* Status can be changed between ACTIVE (id: 1) and SUSPENDED (id: 2), and from ACTIVATION_PENDING (id: 0) to SUSPENDED.\n\n\n Modifying the username invalidates account and triggers the activation procedure.\n\n" }, "response": [ { "id": "0c510505-ad23-4277-af0c-b9fb7d4d8e77", "name": "The server has successfully fulfilled the request and that there is no additional content to send in the response payload body", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"name\": \"\",\n \"status\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0c510505-ad23-4277-af0c-b9fb7d4d8e77" }, { "id": "37f27c9f-6e51-426f-9197-24709ef272b3", "name": "Unprocessable Entity. See HTTP response body for details.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"name\": \"\",\n \"status\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-37f27c9f-6e51-426f-9197-24709ef272b3" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0221c993-1c8a-4491-bdb3-625bd4f5e78e" } ], "id": "5f6bb839-1fde-4bb8-855c-9e661c48247e", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5f6bb839-1fde-4bb8-855c-9e661c48247e" }, { "name": "List user accounts", "id": "6b0a90da-dfdc-4f01-9050-c7d93c70773f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/user?page=&q=&per_page=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user" ], "query": [ { "description": "Current page number", "key": "page", "value": "" }, { "description": "Filter parameter in `:` format. Multiple filters must be in the format of a comma separated list of the following fields:\n\n* `id`\n* `status`\n* `name`\n* `username`\n* `organisation`\n", "key": "q", "value": "" }, { "description": "Defines the number of items per page", "key": "per_page", "value": "" }, { "description": "Sort parameter in `` format.\nExpects a comma-separated list from the allowed fields:\n\n* `id`\n* `status`\n* `name`\n* `username`\n* `organisation`\n* `created`\n", "key": "sort", "value": "" } ] }, "description": "Retrieves the collection of user accounts, filtered, sorted and paged accourding to query parameters.\n" }, "response": [ { "id": "7a71b4bc-7ea8-4c76-8b50-b5ba4b862455", "name": "Successfully returned a list of Users", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/user?page=&q=&per_page=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user" ], "query": [ { "description": "Current page number", "key": "page", "value": "" }, { "description": "Filter parameter in `:` format. Multiple filters must be in the format of a comma separated list of the following fields:\n\n* `id`\n* `status`\n* `name`\n* `username`\n* `organisation`\n", "key": "q", "value": "" }, { "description": "Defines the number of items per page", "key": "per_page", "value": "" }, { "description": "Sort parameter in `` format.\nExpects a comma-separated list from the allowed fields:\n\n* `id`\n* `status`\n* `name`\n* `username`\n* `organisation`\n* `created`\n", "key": "sort", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"username\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"organisation\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"username\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n },\n \"organisation\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7a71b4bc-7ea8-4c76-8b50-b5ba4b862455" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6b0a90da-dfdc-4f01-9050-c7d93c70773f" }, { "name": "Create user", "id": "44cc3194-64e4-487d-86e0-13f741c9baf5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"name\": \"\",\n \"organisation\": {},\n \"roles\": []\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user" ] }, "description": "Creates a user which is *not active and has no password assigned*.\nThe URL to get the user details is provided as Location Header in the response.\n\n#### ACTIVATION\n\nUpon creation, the user account undergoes an activation process (see services below ) in which she receives an email with activation link.\nFollowing this link the user is asked to set the password and upon successful completion of this process, the account becomes active and operational.\n\nProvided fields:\n\n* `username` (String required) - has to be the email of this user\n* `name` (String required)\n* `organisation` (Object optional) - **may be provided** by regular user, but **is required** for master user.\n* `roles` (List of Objects optional) - List of one or more role Ids to be assigned at once. If missing, a default role is assigned\n\n#### Notes\n\n* Password is not provided. Separate calls provide password management.\n* When the organisation of the new user is not specified in the request, it is inherited from the user creating the account.\n\nA regular user is allowed to specify **only organisations which are direct children** of his/her own organisation, or his/her own organisation.\n* The status field is not user editable at account creation time - the default imposed by server is ACTIVATION_PENDING.\n" }, "response": [ { "id": "1ad4121a-6cab-430e-aca3-176e41d456fa", "name": "Resource Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"name\": \"\",\n \"organisation\": {},\n \"roles\": []\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1ad4121a-6cab-430e-aca3-176e41d456fa" }, { "id": "468a9cde-0767-48c9-9fd2-af48f7f3349d", "name": "Unexpected error in API call. See HTTP response body for details.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"name\": \"\",\n \"organisation\": {},\n \"roles\": []\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-468a9cde-0767-48c9-9fd2-af48f7f3349d" }, { "id": "86acf68f-8e95-4c70-9b46-e4ae8bb5a837", "name": "Unprocessable Entity. See HTTP response body for details.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"name\": \"\",\n \"organisation\": {},\n \"roles\": []\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/user", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "user" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-86acf68f-8e95-4c70-9b46-e4ae8bb5a837" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-44cc3194-64e4-487d-86e0-13f741c9baf5" } ], "id": "47a003e3-c1b2-422d-b550-4c06f61037f8", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-47a003e3-c1b2-422d-b550-4c06f61037f8" } ], "id": "99fee7f9-0de9-436c-a39c-4c7abc104dc8", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-99fee7f9-0de9-436c-a39c-4c7abc104dc8" }, { "name": "v2", "item": [ { "name": "bulk-operations", "item": [ { "name": "endpoint", "item": [ { "name": "add-tags", "item": [ { "name": "Bulk assign tags", "id": "d146f2de-9428-42b0-b53e-76da8f2e20e0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n },\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/bulk-operations/endpoint/add-tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "bulk-operations", "endpoint", "add-tags" ] }, "description": "Assigns tags in bulk to multiple endpoints.\n" }, "response": [ { "id": "121951c1-f804-4eea-b32b-8551f5e539f0", "name": "Tags successfully assigned.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n },\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/bulk-operations/endpoint/add-tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "bulk-operations", "endpoint", "add-tags" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-121951c1-f804-4eea-b32b-8551f5e539f0" }, { "id": "d43b1dfe-e252-4584-bafa-926748d601d2", "name": "Invalid payload.\nSee HTTP response body for details.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n },\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/bulk-operations/endpoint/add-tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "bulk-operations", "endpoint", "add-tags" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d43b1dfe-e252-4584-bafa-926748d601d2" }, { "id": "2c9f5025-3155-4b5f-a2b0-acfd43a97832", "name": "User does not have permission to bulk assign tags.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n },\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/bulk-operations/endpoint/add-tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "bulk-operations", "endpoint", "add-tags" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2c9f5025-3155-4b5f-a2b0-acfd43a97832" }, { "id": "6ffa93ac-9343-4bbc-bbfe-04532b0b6711", "name": "One or more tags is already assigned.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n },\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/bulk-operations/endpoint/add-tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "bulk-operations", "endpoint", "add-tags" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6ffa93ac-9343-4bbc-bbfe-04532b0b6711" }, { "id": "7760c9bd-cafa-416b-8352-0033a7676a39", "name": "Unprocessable entity.\nSee HTTP response body for details.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n },\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/bulk-operations/endpoint/add-tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "bulk-operations", "endpoint", "add-tags" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7760c9bd-cafa-416b-8352-0033a7676a39" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d146f2de-9428-42b0-b53e-76da8f2e20e0" } ], "id": "7184df84-1007-4d48-a349-b481b0d42145", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7184df84-1007-4d48-a349-b481b0d42145" }, { "name": "remove-tags", "item": [ { "name": "Bulk unassign tags", "id": "7b3462f4-1cec-4679-89a0-aa5d3b82829e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n },\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/bulk-operations/endpoint/remove-tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "bulk-operations", "endpoint", "remove-tags" ] }, "description": "Unassign tags from multiple endpoints in bulk.\n" }, "response": [ { "id": "c809adb9-c858-4f04-9f60-2f47b4cce0bd", "name": "Tags successfully unassigned.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n },\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/bulk-operations/endpoint/remove-tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "bulk-operations", "endpoint", "remove-tags" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c809adb9-c858-4f04-9f60-2f47b4cce0bd" }, { "id": "cbbf088a-9d68-4834-82dd-61f75e70507a", "name": "Invalid payload.\nSee HTTP response body for details.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n },\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/bulk-operations/endpoint/remove-tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "bulk-operations", "endpoint", "remove-tags" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cbbf088a-9d68-4834-82dd-61f75e70507a" }, { "id": "f30013c9-71be-4f80-a876-c65874a38889", "name": "User doesn't have permission to bulk unassign tags.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n },\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/bulk-operations/endpoint/remove-tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "bulk-operations", "endpoint", "remove-tags" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f30013c9-71be-4f80-a876-c65874a38889" }, { "id": "4b5dde1c-02c4-4e2c-9ef3-2b4923df634f", "name": "Unprocessable entity.\nSee HTTP response body for details.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n },\n {\n \"endpoint\": {\n \"id\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/bulk-operations/endpoint/remove-tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "bulk-operations", "endpoint", "remove-tags" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-4b5dde1c-02c4-4e2c-9ef3-2b4923df634f" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7b3462f4-1cec-4679-89a0-aa5d3b82829e" } ], "id": "963cde3c-30e0-4bc9-9cdf-122651dc8b9d", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-963cde3c-30e0-4bc9-9cdf-122651dc8b9d" } ], "id": "389a22be-3074-4945-ba82-1c3347489c1c", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-389a22be-3074-4945-ba82-1c3347489c1c" }, { "name": "tag", "item": [ { "name": "delete-tags", "item": [ { "name": "Bulk delete tags", "id": "6979d88a-4984-4858-a34b-e1dc179eb24d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/bulk-operations/tag/delete-tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "bulk-operations", "tag", "delete-tags" ] }, "description": "Deletes tags in bulk.\n" }, "response": [ { "id": "bcee76cb-2129-4111-9df7-c5361965d004", "name": "Tags successfully deleted.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/bulk-operations/tag/delete-tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "bulk-operations", "tag", "delete-tags" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-bcee76cb-2129-4111-9df7-c5361965d004" }, { "id": "d3b42783-f7c4-400a-85b9-e3d1724940e5", "name": "Invalid payload.\nSee HTTP response body for details.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/bulk-operations/tag/delete-tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "bulk-operations", "tag", "delete-tags" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d3b42783-f7c4-400a-85b9-e3d1724940e5" }, { "id": "13920105-dc4b-4b95-9e01-eec7b887d0a6", "name": "User doesn't have permission to bulk delete tags.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/bulk-operations/tag/delete-tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "bulk-operations", "tag", "delete-tags" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-13920105-dc4b-4b95-9e01-eec7b887d0a6" }, { "id": "efd91cf4-4e0a-4102-ad4b-3b5c2ed5c051", "name": "Unprocessable entity.\nSee HTTP response body for details.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"tags\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/bulk-operations/tag/delete-tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "bulk-operations", "tag", "delete-tags" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-efd91cf4-4e0a-4102-ad4b-3b5c2ed5c051" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6979d88a-4984-4858-a34b-e1dc179eb24d" } ], "id": "814a2c08-8e91-4635-8cc3-16d0b4eb8549", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-814a2c08-8e91-4635-8cc3-16d0b4eb8549" } ], "id": "0d6a8763-cc12-45a7-b8d0-5ddeeb8e7013", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0d6a8763-cc12-45a7-b8d0-5ddeeb8e7013" } ], "id": "00fc4ad6-27ed-4c48-bf01-fdcb96c841e1", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-00fc4ad6-27ed-4c48-bf01-fdcb96c841e1" }, { "name": "data_stream", "item": [ { "name": "filter_field_type", "item": [ { "name": "Get data stream filter fields", "id": "2bf9953f-3304-43f2-ada5-5fadbcb2fa8c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/filter_field_type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", "filter_field_type" ] } }, "response": [ { "id": "fd13f366-0eb3-4ef4-864e-de72bb75aa21", "name": "Possible filter field types that can be used with data streams.\n\n`event_type_id` will filter Event stream for specific event types (e.g. `\"event_type_id\":[1,2,3]`).\n\n`alert` will filter Event stream for alert status (e.g. `\"alert\":true`).\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/filter_field_type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", "filter_field_type" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-fd13f366-0eb3-4ef4-864e-de72bb75aa21" }, { "id": "c9638aa2-47ca-4f9c-8ef7-a3fee891538d", "name": "No or invalid authentication token provided", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/filter_field_type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", "filter_field_type" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c9638aa2-47ca-4f9c-8ef7-a3fee891538d" }, { "id": "933b62d7-596c-43cc-8ce1-254dd3c06008", "name": "Authentication token is valid, but user has no access permissions to the request resource", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/filter_field_type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", "filter_field_type" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-933b62d7-596c-43cc-8ce1-254dd3c06008" }, { "id": "07083404-8efc-4fb9-bad5-1a270dcb2bfc", "name": "A non-existent resource is requested", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/filter_field_type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", "filter_field_type" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-07083404-8efc-4fb9-bad5-1a270dcb2bfc" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2bf9953f-3304-43f2-ada5-5fadbcb2fa8c" } ], "id": "1765c53b-6cd7-4308-9924-363a2f78172c", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1765c53b-6cd7-4308-9924-363a2f78172c" }, { "name": "status", "item": [ { "name": "Get data stream statuses", "id": "b7d815f9-02b7-4585-848b-de1be0b8738b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", "status" ] }, "description": "Lists possible data stream statuses.\n\n(`1`) is the normal `Running` state meaning your data stream is active and streams data.\n\n(`2`) indicates a `Paused` data stream. It will not send messages to your destination.\nHowever, messages meant for this data stream are routed and will be stored up to 7 days.\nYou will first receive historic data once you resume a paused streamer after longer pausing.\n\n(`3`) indicates that an `Error` has occurred. This might be problems in the configuration (e.g. missing permissions)\nor your destination has been unavailable for a longer period of time and the data stream exceeded maximum retries.\nYou may restart the streamer in order to fix a temporary problem, misconfigured streamers will continue to fail.\n\n(`4`) is a `Pending` state. Your data stream has not been initialized, yet.\nThis state may occur for a very short time.\n" }, "response": [ { "id": "8423d8e8-b511-4afb-9a5f-416c11d6ce10", "name": "Possible connection statuses", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8423d8e8-b511-4afb-9a5f-416c11d6ce10" }, { "id": "d6eaf2b5-f37d-4bb0-8f6e-7bb2e45eb706", "name": "No or invalid authentication token provided", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", "status" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d6eaf2b5-f37d-4bb0-8f6e-7bb2e45eb706" }, { "id": "909ba334-0b9e-43bf-a631-965f2f9898fa", "name": "Authentication token is valid, but user has no access permissions to the request resource", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", "status" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-909ba334-0b9e-43bf-a631-965f2f9898fa" }, { "id": "5a9669f6-66a3-42d5-9b6d-b5930438c1c7", "name": "A non-existent resource is requested", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", "status" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5a9669f6-66a3-42d5-9b6d-b5930438c1c7" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b7d815f9-02b7-4585-848b-de1be0b8738b" } ], "id": "1f443684-0fba-4a46-96e9-acc614916d4d", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1f443684-0fba-4a46-96e9-acc614916d4d" }, { "name": "type", "item": [ { "name": "Get data stream types", "id": "7462d4e0-6f41-4567-ae04-244cee242278", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", "type" ] }, "description": "List available Data Stream Types.\n\n(`1`) will only stream `Usage` Data.\n\n(`2`) will only stream `Event` Data.\n" }, "response": [ { "id": "ad89ad00-42bc-4bf3-980a-690746bae5eb", "name": "Possible data stream types", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", "type" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ad89ad00-42bc-4bf3-980a-690746bae5eb" }, { "id": "2f97c06b-b02c-48f0-836e-39579766a61d", "name": "No or invalid authentication token provided", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", "type" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2f97c06b-b02c-48f0-836e-39579766a61d" }, { "id": "b9cf2c7c-09ae-4876-90d6-8e360238ac4f", "name": "Authentication token is valid, but user has no access permissions to the request resource", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", "type" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b9cf2c7c-09ae-4876-90d6-8e360238ac4f" }, { "id": "04970aff-29ac-4e05-a42b-5d7fda624812", "name": "A non-existent resource is requested", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", "type" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-04970aff-29ac-4e05-a42b-5d7fda624812" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7462d4e0-6f41-4567-ae04-244cee242278" } ], "id": "604470cd-e3bb-46cb-ba68-e1d1530c4e73", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-604470cd-e3bb-46cb-ba68-e1d1530c4e73" }, { "name": "{data_stream_id}", "item": [ { "name": "restart", "item": [ { "name": "Restart existing data stream", "id": "a982a442-869d-458e-ac13-a77e2485a57f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id/restart", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id", "restart" ], "variable": [ { "id": "61f32af1-268d-4c36-883c-933215b50a82", "key": "data_stream_id", "value": "", "description": "(Required) ID of a data stream." } ] }, "description": "Restart your Existing Data Stream.\nThis might be necessary when e.g. your Webhook endpoint has been unreachable for an extended period of time.\nWebhook Data Stream will exhaust retries and go into Error State.\nBy using this API call your Data Stream will be restarted and continue trying to send data.\n" }, "response": [ { "id": "d5747522-4506-484c-b56c-245d8f265dc8", "name": "Request accepted", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id/restart", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id", "restart" ], "variable": [ { "key": "data_stream_id" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d5747522-4506-484c-b56c-245d8f265dc8" }, { "id": "742300db-3b5f-47b8-8362-de822ca6ea32", "name": "No or invalid authentication token provided", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id/restart", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id", "restart" ], "variable": [ { "key": "data_stream_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-742300db-3b5f-47b8-8362-de822ca6ea32" }, { "id": "0270208a-822a-4708-8594-02fddc64884a", "name": "Authentication token is valid, but user has no access permissions to the request resource", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id/restart", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id", "restart" ], "variable": [ { "key": "data_stream_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0270208a-822a-4708-8594-02fddc64884a" }, { "id": "41b96d9e-70b9-4990-882d-37f963f33fdf", "name": "A non-existent resource is requested", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id/restart", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id", "restart" ], "variable": [ { "key": "data_stream_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-41b96d9e-70b9-4990-882d-37f963f33fdf" }, { "id": "e3d9298a-b0c8-4303-a184-fbc183cec3fa", "name": "The request could not be completed due to a conflict with the current state of the resource.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id/restart", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id", "restart" ], "variable": [ { "key": "data_stream_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e3d9298a-b0c8-4303-a184-fbc183cec3fa" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a982a442-869d-458e-ac13-a77e2485a57f" } ], "id": "0c7ddfc1-a32e-4744-8b6e-ed9be41a9d0c", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0c7ddfc1-a32e-4744-8b6e-ed9be41a9d0c" }, { "name": "Get details on existing data stream", "id": "e9fbdceb-8b08-4066-9fe6-3fe81d07dec6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id" ], "variable": [ { "id": "954e3743-82f3-4e34-87e6-ca0f434ac03f", "key": "data_stream_id", "value": "", "description": "(Required) ID of a data stream." } ] }, "description": "Get data stream configuration and status by ID.\n" }, "response": [ { "id": "ff2bb2c1-d989-4bdb-8a38-faec80109bfb", "name": "Single Data Stream Configuration", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id" ], "variable": [ { "key": "data_stream_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"destination\": {\n \"connection_type\": \"\",\n \"format\": \"\",\n \"credentials\": {\n \"region\": \"\",\n \"stream_name\": \"\",\n \"role_arn\": \"\"\n }\n },\n \"filters\": [\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n },\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"data_stream_type\": {\n \"description\": \"Any type\"\n },\n \"relation_resolution\": {\n \"description\": \"Any type\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ff2bb2c1-d989-4bdb-8a38-faec80109bfb" }, { "id": "97d720ff-bec3-471b-b113-f9f940ecd4a9", "name": "No or invalid authentication token provided", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id" ], "variable": [ { "key": "data_stream_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-97d720ff-bec3-471b-b113-f9f940ecd4a9" }, { "id": "6cdf7a92-e281-4795-bf92-db030409640c", "name": "Authentication token is valid, but user has no access permissions to the request resource", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id" ], "variable": [ { "key": "data_stream_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6cdf7a92-e281-4795-bf92-db030409640c" }, { "id": "f9859e15-ec49-4125-b135-0f2f91ee4d21", "name": "A non-existent resource is requested", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id" ], "variable": [ { "key": "data_stream_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f9859e15-ec49-4125-b135-0f2f91ee4d21" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e9fbdceb-8b08-4066-9fe6-3fe81d07dec6" }, { "name": "Delete existing data stream", "id": "91f6202c-517f-4593-b21d-cb8218090134", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id" ], "variable": [ { "id": "295a2db6-9265-46e8-9283-ce7faf8f97ee", "key": "data_stream_id", "value": "", "description": "(Required) ID of a data stream." } ] } }, "response": [ { "id": "e7ff32a5-eb60-4ce1-8406-ee67203afdb5", "name": "Request accepted", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id" ], "variable": [ { "key": "data_stream_id" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e7ff32a5-eb60-4ce1-8406-ee67203afdb5" }, { "id": "6a5a1317-6598-438d-9704-cc7371cd8fb8", "name": "No or invalid authentication token provided", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id" ], "variable": [ { "key": "data_stream_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6a5a1317-6598-438d-9704-cc7371cd8fb8" }, { "id": "e6c567d9-fb35-4f27-baf7-27fe1ed830ec", "name": "Authentication token is valid, but user has no access permissions to the request resource", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id" ], "variable": [ { "key": "data_stream_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e6c567d9-fb35-4f27-baf7-27fe1ed830ec" }, { "id": "20eefa17-46f4-475e-a6a9-6033c1722b79", "name": "A non-existent resource is requested", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id" ], "variable": [ { "key": "data_stream_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-20eefa17-46f4-475e-a6a9-6033c1722b79" }, { "id": "7644e56d-a4e6-42fd-b535-b57d7ca1299c", "name": "The request could not be completed due to a conflict with the current state of the resource.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id" ], "variable": [ { "key": "data_stream_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7644e56d-a4e6-42fd-b535-b57d7ca1299c" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-91f6202c-517f-4593-b21d-cb8218090134" }, { "name": "Modify existing data stream", "id": "467b3838-2720-4694-8b7d-1f17a776983e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"destination\": {\n \"connection_type\": \"\",\n \"format\": \"\",\n \"credentials\": {\n \"region\": \"\",\n \"stream_name\": \"\",\n \"role_arn\": \"\"\n }\n },\n \"filters\": [\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n },\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"data_stream_type\": {\n \"description\": \"Any type\"\n },\n \"relation_resolution\": {\n \"description\": \"Any type\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id" ], "variable": [ { "id": "c6099aff-da36-4fd4-a476-fc62301d0dd4", "key": "data_stream_id", "value": "", "description": "(Required) ID of a data stream." } ] } }, "response": [ { "id": "20105417-4527-485b-b44c-fccc4d2b0a60", "name": "Request accepted", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"destination\": {\n \"connection_type\": \"\",\n \"format\": \"\",\n \"credentials\": {\n \"region\": \"\",\n \"stream_name\": \"\",\n \"role_arn\": \"\"\n }\n },\n \"filters\": [\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n },\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"data_stream_type\": {\n \"description\": \"Any type\"\n },\n \"relation_resolution\": {\n \"description\": \"Any type\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id" ], "variable": [ { "key": "data_stream_id" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-20105417-4527-485b-b44c-fccc4d2b0a60" }, { "id": "72391984-7762-4828-9ca5-3a71b88a802f", "name": "No or invalid authentication token provided", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"destination\": {\n \"connection_type\": \"\",\n \"format\": \"\",\n \"credentials\": {\n \"region\": \"\",\n \"stream_name\": \"\",\n \"role_arn\": \"\"\n }\n },\n \"filters\": [\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n },\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"data_stream_type\": {\n \"description\": \"Any type\"\n },\n \"relation_resolution\": {\n \"description\": \"Any type\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id" ], "variable": [ { "key": "data_stream_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-72391984-7762-4828-9ca5-3a71b88a802f" }, { "id": "a7f72015-c486-42d4-befb-5e05c45fd15a", "name": "Authentication token is valid, but user has no access permissions to the request resource", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"destination\": {\n \"connection_type\": \"\",\n \"format\": \"\",\n \"credentials\": {\n \"region\": \"\",\n \"stream_name\": \"\",\n \"role_arn\": \"\"\n }\n },\n \"filters\": [\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n },\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"data_stream_type\": {\n \"description\": \"Any type\"\n },\n \"relation_resolution\": {\n \"description\": \"Any type\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id" ], "variable": [ { "key": "data_stream_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a7f72015-c486-42d4-befb-5e05c45fd15a" }, { "id": "93f1f691-0aae-44af-b65a-2b9c9e75a888", "name": "A non-existent resource is requested", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"destination\": {\n \"connection_type\": \"\",\n \"format\": \"\",\n \"credentials\": {\n \"region\": \"\",\n \"stream_name\": \"\",\n \"role_arn\": \"\"\n }\n },\n \"filters\": [\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n },\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"data_stream_type\": {\n \"description\": \"Any type\"\n },\n \"relation_resolution\": {\n \"description\": \"Any type\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id" ], "variable": [ { "key": "data_stream_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-93f1f691-0aae-44af-b65a-2b9c9e75a888" }, { "id": "208febd0-213b-459b-9daf-fc7bb9cfd1d5", "name": "Body will return list of validation errors", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"destination\": {\n \"connection_type\": \"\",\n \"format\": \"\",\n \"credentials\": {\n \"region\": \"\",\n \"stream_name\": \"\",\n \"role_arn\": \"\"\n }\n },\n \"filters\": [\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n },\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"data_stream_type\": {\n \"description\": \"Any type\"\n },\n \"relation_resolution\": {\n \"description\": \"Any type\"\n },\n \"status\": {\n \"id\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/data_stream/:data_stream_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream", ":data_stream_id" ], "variable": [ { "key": "data_stream_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-208febd0-213b-459b-9daf-fc7bb9cfd1d5" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-467b3838-2720-4694-8b7d-1f17a776983e" } ], "id": "52eb07ee-8061-469e-ba6a-3226f0337c46", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-52eb07ee-8061-469e-ba6a-3226f0337c46" }, { "name": "List data stream configurations of your organization", "id": "7ab70017-6c03-4002-8166-d587819c617f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream" ] } }, "response": [ { "id": "fc4e824d-2bf6-454e-a80b-6a2172b93c5e", "name": "List of data stream with their current status", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"destination\": {\n \"connection_type\": \"\",\n \"format\": \"\",\n \"credentials\": {\n \"region\": \"\",\n \"stream_name\": \"\",\n \"role_arn\": \"\"\n }\n },\n \"filters\": [\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n },\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"data_stream_type\": {\n \"description\": \"Any type\"\n },\n \"relation_resolution\": {\n \"description\": \"Any type\"\n },\n \"status\": {\n \"description\": \"Any type\"\n }\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-fc4e824d-2bf6-454e-a80b-6a2172b93c5e" }, { "id": "44179f70-b8f5-4a55-b5f2-0adaf11f0755", "name": "The request is malformed, e.g. the body cannot be parsed", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-44179f70-b8f5-4a55-b5f2-0adaf11f0755" }, { "id": "3dbbfc3a-8129-4d68-8b65-e40c15da03e8", "name": "No or invalid authentication token provided", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3dbbfc3a-8129-4d68-8b65-e40c15da03e8" }, { "id": "580513d9-b65d-4bb9-b698-a94d8c61da09", "name": "Authentication token is valid, but user has no access permissions to the request resource", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-580513d9-b65d-4bb9-b698-a94d8c61da09" }, { "id": "95cbfc21-7eaf-4f3d-97f2-e742c9100e1d", "name": "A non-existent resource is requested", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/data_stream", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-95cbfc21-7eaf-4f3d-97f2-e742c9100e1d" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7ab70017-6c03-4002-8166-d587819c617f" }, { "name": "Create data stream", "id": "5f4e7234-20c5-4e9a-8b4d-1c0e38887b60", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"destination\": {\n \"connection_type\": \"\",\n \"format\": \"\",\n \"credentials\": {\n \"region\": \"\",\n \"stream_name\": \"\",\n \"role_arn\": \"\"\n }\n },\n \"filters\": [\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n },\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"data_stream_type\": {\n \"description\": \"Any type\"\n },\n \"relation_resolution\": {\n \"description\": \"Any type\"\n },\n \"status\": {\n \"description\": \"Any type\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/data_stream", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream" ] }, "description": "Create Data Stream to your destination.\nClick on Examples to see available Data Streams and configuration parameters.\n\nCurrently available `connection_types` are\n- `AwsKinesis`\n- `S3`\n- `RestAPI`\n- `KeenIO`\n- `Datadog`\n- `EventHubs`\n- `PubSub`\n" }, "response": [ { "id": "008f854e-508e-4319-b1a7-f328a4ebdf55", "name": "Data stream has been successfully created.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"destination\": {\n \"connection_type\": \"\",\n \"format\": \"\",\n \"credentials\": {\n \"region\": \"\",\n \"stream_name\": \"\",\n \"role_arn\": \"\"\n }\n },\n \"filters\": [\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n },\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"data_stream_type\": {\n \"description\": \"Any type\"\n },\n \"relation_resolution\": {\n \"description\": \"Any type\"\n },\n \"status\": {\n \"description\": \"Any type\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/data_stream", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-008f854e-508e-4319-b1a7-f328a4ebdf55" }, { "id": "b1b6bb06-6e1e-4b26-8b2f-8a47b18f5d21", "name": "No or invalid authentication token provided", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"destination\": {\n \"connection_type\": \"\",\n \"format\": \"\",\n \"credentials\": {\n \"region\": \"\",\n \"stream_name\": \"\",\n \"role_arn\": \"\"\n }\n },\n \"filters\": [\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n },\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"data_stream_type\": {\n \"description\": \"Any type\"\n },\n \"relation_resolution\": {\n \"description\": \"Any type\"\n },\n \"status\": {\n \"description\": \"Any type\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/data_stream", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b1b6bb06-6e1e-4b26-8b2f-8a47b18f5d21" }, { "id": "e1e55829-8e40-4a1b-883c-8e3b5c68e7e7", "name": "Authentication token is valid, but user has no access permissions to the request resource", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"destination\": {\n \"connection_type\": \"\",\n \"format\": \"\",\n \"credentials\": {\n \"region\": \"\",\n \"stream_name\": \"\",\n \"role_arn\": \"\"\n }\n },\n \"filters\": [\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n },\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"data_stream_type\": {\n \"description\": \"Any type\"\n },\n \"relation_resolution\": {\n \"description\": \"Any type\"\n },\n \"status\": {\n \"description\": \"Any type\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/data_stream", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e1e55829-8e40-4a1b-883c-8e3b5c68e7e7" }, { "id": "93a564a1-d0c6-4506-9559-6ce587bfa5b4", "name": "A non-existent resource is requested", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"destination\": {\n \"connection_type\": \"\",\n \"format\": \"\",\n \"credentials\": {\n \"region\": \"\",\n \"stream_name\": \"\",\n \"role_arn\": \"\"\n }\n },\n \"filters\": [\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n },\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"data_stream_type\": {\n \"description\": \"Any type\"\n },\n \"relation_resolution\": {\n \"description\": \"Any type\"\n },\n \"status\": {\n \"description\": \"Any type\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/data_stream", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-93a564a1-d0c6-4506-9559-6ce587bfa5b4" }, { "id": "e272bba3-caf4-4596-aec1-5723d4545778", "name": "Configuration for the data stream is invalid. Please check your Request Body for errors.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"destination\": {\n \"connection_type\": \"\",\n \"format\": \"\",\n \"credentials\": {\n \"region\": \"\",\n \"stream_name\": \"\",\n \"role_arn\": \"\"\n }\n },\n \"filters\": [\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n },\n {\n \"field\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"data_stream_type\": {\n \"description\": \"Any type\"\n },\n \"relation_resolution\": {\n \"description\": \"Any type\"\n },\n \"status\": {\n \"description\": \"Any type\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/data_stream", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "data_stream" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e272bba3-caf4-4596-aec1-5723d4545778" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5f4e7234-20c5-4e9a-8b4d-1c0e38887b60" } ], "id": "ba513868-ab53-4e5d-b49b-839c45be33ae", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ba513868-ab53-4e5d-b49b-839c45be33ae" }, { "name": "endpoint", "item": [ { "name": "multi", "item": [ { "name": "Bulk create endpoints", "id": "00d4df41-1325-4e64-889e-b9a6a4a625b1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"endpoints\": [\n {\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"sim\": {\n \"id\": \"\",\n \"activate\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n },\n \"ip_address\": \"\"\n },\n {\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"sim\": {\n \"id\": \"\",\n \"activate\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n },\n \"ip_address\": \"\"\n }\n ],\n \"organisation\": {\n \"id\": \"\"\n },\n \"ip_address_space\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/multi", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", "multi" ] }, "description": "Create up to 2,000 endpoints in one request.\n\nUnlike [`POST /api/v1/endpoint`](/developers/api/endpoint/create-endpoint), this bulk endpoint handles multiple endpoints safely in a single request without sequential execution constraints between individual endpoints.\n\n\n Execute bulk operations sequentially - wait for each bulk request to complete before starting the next.\n\n\nIf a `sim` object is provided, the specified SIM is assigned to the endpoint.\nThe `activate` property defaults to `false` and can be omitted unless the SIM should be activated during this call.\n\nIf `activate` is set to `true`:\n- The SIM enters Factory Test Mode (FTM) if FTM is enabled for the organization.\n- Otherwise, it goes directly to **Activated**.\n\nTo override this behavior and explicitly set the SIM's status (for example, skip FTM even if it's enabled for your organization), include a `status` object within the `sim` object.\n\n\n emnify charges for activated SIMs, even if the endpoint status is set to **Disabled**.\n\n" }, "response": [ { "id": "8ad98d6c-bc16-4aeb-b140-baf3d81938d8", "name": "response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"endpoints\": [\n {\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"sim\": {\n \"id\": \"\",\n \"activate\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n },\n \"ip_address\": \"\"\n },\n {\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"sim\": {\n \"id\": \"\",\n \"activate\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n },\n \"ip_address\": \"\"\n }\n ],\n \"organisation\": {\n \"id\": \"\"\n },\n \"ip_address_space\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/multi", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", "multi" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"ip_address\": \"\",\n \"status\": {\n \"description\": \"\"\n },\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"created\": \"\",\n \"last_updated\": \"\",\n \"imei_lock\": \"\",\n \"service_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\",\n \"name\": \"\",\n \"satellite_capable\": \"\"\n },\n \"sim\": {},\n \"ip_address_space\": {},\n \"imei_with_luhn\": {}\n },\n {\n \"id\": \"\",\n \"ip_address\": \"\",\n \"status\": {\n \"description\": \"\"\n },\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"created\": \"\",\n \"last_updated\": \"\",\n \"imei_lock\": \"\",\n \"service_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\",\n \"name\": \"\",\n \"satellite_capable\": \"\"\n },\n \"sim\": {},\n \"ip_address_space\": {},\n \"imei_with_luhn\": {}\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8ad98d6c-bc16-4aeb-b140-baf3d81938d8" }, { "id": "2f705204-5c38-461b-93c4-c056aa0ce7c6", "name": "Request body is malformed", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"endpoints\": [\n {\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"sim\": {\n \"id\": \"\",\n \"activate\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n },\n \"ip_address\": \"\"\n },\n {\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"sim\": {\n \"id\": \"\",\n \"activate\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n },\n \"ip_address\": \"\"\n }\n ],\n \"organisation\": {\n \"id\": \"\"\n },\n \"ip_address_space\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/multi", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", "multi" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2f705204-5c38-461b-93c4-c056aa0ce7c6" }, { "id": "6d1f0cca-1314-4026-9ef7-11b711a03738", "name": "User doesn't have permission to bulk create endpoints\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"endpoints\": [\n {\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"sim\": {\n \"id\": \"\",\n \"activate\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n },\n \"ip_address\": \"\"\n },\n {\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"sim\": {\n \"id\": \"\",\n \"activate\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n },\n \"ip_address\": \"\"\n }\n ],\n \"organisation\": {\n \"id\": \"\"\n },\n \"ip_address_space\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/multi", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", "multi" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6d1f0cca-1314-4026-9ef7-11b711a03738" }, { "id": "6c20d045-d8a0-4a62-930f-ef46d10d5aa8", "name": "IP address space is full", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"endpoints\": [\n {\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"sim\": {\n \"id\": \"\",\n \"activate\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n },\n \"ip_address\": \"\"\n },\n {\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"sim\": {\n \"id\": \"\",\n \"activate\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n },\n \"ip_address\": \"\"\n }\n ],\n \"organisation\": {\n \"id\": \"\"\n },\n \"ip_address_space\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/multi", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", "multi" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6c20d045-d8a0-4a62-930f-ef46d10d5aa8" }, { "id": "c2996876-934d-4802-a6ed-dd4a82f7646e", "name": "Appears in one of the following cases:\n\n- Service profile is invalid\n- Tariff profile is invalid\n- Status is invalid\n- IP address space is invalid\n- Organization is invalid\n- Endpoints are invalid\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"endpoints\": [\n {\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"sim\": {\n \"id\": \"\",\n \"activate\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n },\n \"ip_address\": \"\"\n },\n {\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"sim\": {\n \"id\": \"\",\n \"activate\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n },\n \"ip_address\": \"\"\n }\n ],\n \"organisation\": {\n \"id\": \"\"\n },\n \"ip_address_space\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/multi", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", "multi" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c2996876-934d-4802-a6ed-dd4a82f7646e" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-00d4df41-1325-4e64-889e-b9a6a4a625b1" }, { "name": "Bulk delete endpoints", "id": "2d53340b-1ee4-49ed-bb45-b7cc45bcb8cd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/multi?delete_sims=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", "multi" ], "query": [ { "description": "If `true`, the SIMs will be deleted along with the endpoints.\nIf `false`, the SIMs will only be suspended.\nDefaults to `false`.\n", "key": "delete_sims", "value": "false" } ] }, "description": "Deletes a list of endpoints in bulk, along with all child entities.\n\nUnlike [`DELETE /api/v1/endpoint/{endpoint_id}`](/developers/api/endpoint/endpoint-by-id-delete), this bulk endpoint handles multiple endpoints safely in a single request without sequential execution constraints between individual endpoints.\n\n\n Execute bulk operations sequentially - wait for each bulk request to complete before starting the next.\n\n\nIf a SIM is assigned to one of the endpoints, it's released and suspended.\nIf the `delete_sims` query parameter is set to `true`, the SIMs are also deleted.\n" }, "response": [ { "id": "696d9b24-c0a4-45a2-b611-5597136097bc", "name": "Endpoints deleted successfully", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/multi?delete_sims=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", "multi" ], "query": [ { "description": "If `true`, the SIMs will be deleted along with the endpoints.\nIf `false`, the SIMs will only be suspended.\nDefaults to `false`.\n", "key": "delete_sims", "value": "false" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-696d9b24-c0a4-45a2-b611-5597136097bc" }, { "id": "5008daad-3f5f-45a0-98d3-0882327b9e60", "name": "Request body is malformed", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/multi?delete_sims=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", "multi" ], "query": [ { "description": "If `true`, the SIMs will be deleted along with the endpoints.\nIf `false`, the SIMs will only be suspended.\nDefaults to `false`.\n", "key": "delete_sims", "value": "false" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5008daad-3f5f-45a0-98d3-0882327b9e60" }, { "id": "f9d1c405-e461-4c70-88c0-7f14ea38349c", "name": "User doesn't have permission to bulk delete endpoints\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/multi?delete_sims=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", "multi" ], "query": [ { "description": "If `true`, the SIMs will be deleted along with the endpoints.\nIf `false`, the SIMs will only be suspended.\nDefaults to `false`.\n", "key": "delete_sims", "value": "false" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f9d1c405-e461-4c70-88c0-7f14ea38349c" }, { "id": "25cd209f-36f6-4025-8653-2d689760301b", "name": "Requested endpoint ID isn't found\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/multi?delete_sims=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", "multi" ], "query": [ { "description": "If `true`, the SIMs will be deleted along with the endpoints.\nIf `false`, the SIMs will only be suspended.\nDefaults to `false`.\n", "key": "delete_sims", "value": "false" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-25cd209f-36f6-4025-8653-2d689760301b" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2d53340b-1ee4-49ed-bb45-b7cc45bcb8cd" }, { "name": "Bulk update endpoints", "id": "23df278f-4d43-497a-a912-4e0755247a4e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"ip_address\": \"\",\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"sim\": {\n \"id\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"ip_address\": \"\",\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"sim\": {\n \"id\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/multi", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", "multi" ] }, "description": "Updates details of a list of endpoints in bulk.\n\nThe request body must be an array of endpoint objects.\nEach object requires an `id` field to identify the endpoint, and you only need to include the fields you want to update.\n\nUnlike [`PATCH /api/v1/endpoint/{endpoint_id}`](/developers/api/endpoint/endpoint-by-id-patch), this bulk endpoint handles multiple endpoints safely in a single request without sequential execution constraints between individual endpoints.\n\n\n Execute bulk operations sequentially - wait for each bulk request to complete before starting the next.\n\n\n\n emnify charges for activated SIMs, even if the endpoint status is set to **Disabled**.\n To avoid accruing unexpected charges, update the SIM status to **Suspended** (`\"id\": 2`).\n\n" }, "response": [ { "id": "2570e3fb-bd37-4323-8aa0-77a1234ad61f", "name": "Endpoints updated successfully", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"ip_address\": \"\",\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"sim\": {\n \"id\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"ip_address\": \"\",\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"sim\": {\n \"id\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/multi", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", "multi" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2570e3fb-bd37-4323-8aa0-77a1234ad61f" }, { "id": "61d9bc07-7572-4235-8295-46b36382ae62", "name": "Request body is malformed", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"ip_address\": \"\",\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"sim\": {\n \"id\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"ip_address\": \"\",\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"sim\": {\n \"id\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/multi", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", "multi" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-61d9bc07-7572-4235-8295-46b36382ae62" }, { "id": "38fc41c0-6012-429e-8433-bc9b8e718451", "name": "User doesn't have permission to bulk update endpoints\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"ip_address\": \"\",\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"sim\": {\n \"id\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"ip_address\": \"\",\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"sim\": {\n \"id\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/multi", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", "multi" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-38fc41c0-6012-429e-8433-bc9b8e718451" }, { "id": "cb3fa9d4-bdf5-45c2-ab9e-9126ebece2ad", "name": "Appears in one of the following cases:\n\n- IP address space isn't found\n- IP address space is full\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"ip_address\": \"\",\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"sim\": {\n \"id\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"ip_address\": \"\",\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"sim\": {\n \"id\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/multi", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", "multi" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cb3fa9d4-bdf5-45c2-ab9e-9126ebece2ad" }, { "id": "e60b993c-0e20-4742-bfec-950b98a7d9f2", "name": "Appears in one of the following cases:\n\n- Service profile is invalid\n- Tariff profile is invalid\n- Status is invalid\n- IP address space is invalid\n- IP address is invalid\n- SIM is invalid\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"ip_address\": \"\",\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"sim\": {\n \"id\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"tags\": \"\",\n \"imei\": \"\",\n \"imei_lock\": \"\",\n \"ip_address\": \"\",\n \"ip_address_space\": {\n \"id\": \"\"\n },\n \"service_profile\": {\n \"id\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"status\": {\n \"id\": \"\"\n },\n \"sim\": {\n \"id\": \"\",\n \"status\": {\n \"id\": \"\"\n }\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/multi", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", "multi" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e60b993c-0e20-4742-bfec-950b98a7d9f2" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-23df278f-4d43-497a-a912-4e0755247a4e" } ], "id": "5418b6a1-4df8-4e56-b855-e541b6909ad2", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-5418b6a1-4df8-4e56-b855-e541b6909ad2" }, { "name": "{endpoint_id}", "item": [ { "name": "tags", "item": [ { "name": "{tag_id}", "item": [ { "name": "Unassign a tag from an endpoint", "id": "59f8ba16-12cd-4124-9165-4f6d667763e5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/endpoint/:endpoint_id/tags/:tag_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", ":endpoint_id", "tags", ":tag_id" ], "variable": [ { "id": "018d2ca0-8ffc-4091-974a-4c5f6afd0e8b", "key": "endpoint_id", "value": "", "description": "(Required) Numeric ID of an endpoint" }, { "id": "2b4769d4-c5e5-4057-a7c4-819f041df2b4", "key": "tag_id", "value": "", "description": "(Required) The tag ID" } ] }, "description": "Unassigns a tag from the provided endpoint.\nTo successfully unassign a tag, you must include the tag's ID in the request body.\n" }, "response": [ { "id": "74d25977-67cb-49de-bc4a-b4e724dfa653", "name": "Tag successfully unassigned from the endpoint.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/endpoint/:endpoint_id/tags/:tag_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", ":endpoint_id", "tags", ":tag_id" ], "variable": [ { "key": "endpoint_id" }, { "key": "tag_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-74d25977-67cb-49de-bc4a-b4e724dfa653" }, { "id": "0808db54-1518-4ec7-85c0-d3088b8cd204", "name": "Invalid payload.\nSee HTTP response body for details.\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/endpoint/:endpoint_id/tags/:tag_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", ":endpoint_id", "tags", ":tag_id" ], "variable": [ { "key": "endpoint_id" }, { "key": "tag_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0808db54-1518-4ec7-85c0-d3088b8cd204" }, { "id": "79f6adbe-e3ac-404d-9327-31de51bf56a9", "name": "User doesn't have permission to unassign tags.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/endpoint/:endpoint_id/tags/:tag_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", ":endpoint_id", "tags", ":tag_id" ], "variable": [ { "key": "endpoint_id" }, { "key": "tag_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-79f6adbe-e3ac-404d-9327-31de51bf56a9" }, { "id": "d6ed1149-2090-428b-b415-b8ccb83078eb", "name": "The provided tag ID doesn't exist.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/endpoint/:endpoint_id/tags/:tag_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", ":endpoint_id", "tags", ":tag_id" ], "variable": [ { "key": "endpoint_id" }, { "key": "tag_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d6ed1149-2090-428b-b415-b8ccb83078eb" }, { "id": "af7d3087-f403-4edf-a758-d4228b24abd5", "name": "Unprocessable entity.\nSee HTTP response body for details.\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/endpoint/:endpoint_id/tags/:tag_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", ":endpoint_id", "tags", ":tag_id" ], "variable": [ { "key": "endpoint_id" }, { "key": "tag_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-af7d3087-f403-4edf-a758-d4228b24abd5" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-59f8ba16-12cd-4124-9165-4f6d667763e5" } ], "id": "b021173c-c3bd-4cfa-8054-2a1e1e2e29f1", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b021173c-c3bd-4cfa-8054-2a1e1e2e29f1" }, { "name": "List endpoint tags", "id": "9909a9d8-ff5b-4d61-b5ab-02690ac1665d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/endpoint/:endpoint_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", ":endpoint_id", "tags" ], "variable": [ { "id": "03deb84d-59ae-4c77-a6a9-da3138befcba", "key": "endpoint_id", "value": "", "description": "(Required) Numeric ID of an endpoint" } ] }, "description": "Returns a list of tags assigned to the provided endpoint.\n" }, "response": [ { "id": "272b94c1-097f-4187-8167-075e3fe5cd2c", "name": "Tags successfully listed.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/endpoint/:endpoint_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", ":endpoint_id", "tags" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"resource_count\": \"\",\n \"tag_color\": {\n \"id\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"resource_count\": \"\",\n \"tag_color\": {\n \"id\": \"\"\n }\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-272b94c1-097f-4187-8167-075e3fe5cd2c" }, { "id": "91b7d3b9-4d10-4d67-8dbf-6d959a593e6f", "name": "Invalid payload.\nSee HTTP response body for details.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/endpoint/:endpoint_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", ":endpoint_id", "tags" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-91b7d3b9-4d10-4d67-8dbf-6d959a593e6f" }, { "id": "97aeb00d-100e-44e3-bbcd-a0b22dd2b880", "name": "User doesn't have permission to list endpoint tags.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/endpoint/:endpoint_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", ":endpoint_id", "tags" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-97aeb00d-100e-44e3-bbcd-a0b22dd2b880" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9909a9d8-ff5b-4d61-b5ab-02690ac1665d" }, { "name": "Assign a tag to an endpoint", "id": "f15824f3-7b3b-4514-a0f1-cf902cd61026", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/:endpoint_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", ":endpoint_id", "tags" ], "variable": [ { "id": "021a0d78-bcca-464c-89c3-628bab5d3ae9", "key": "endpoint_id", "value": "", "description": "(Required) Numeric ID of an endpoint" } ] }, "description": "Assigns a tag to the provided endpoint.\nTo successfully assign a tag, you must include the tag's ID in the request body.\n" }, "response": [ { "id": "369a3172-bf96-4bb7-9af4-e88d66b4baec", "name": "Tag successfully assigned to the endpoint.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/:endpoint_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", ":endpoint_id", "tags" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-369a3172-bf96-4bb7-9af4-e88d66b4baec" }, { "id": "2d621ed4-adc7-47f5-bfe1-96a0e933e834", "name": "Invalid payload.\nSee HTTP response body for details.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/:endpoint_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", ":endpoint_id", "tags" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2d621ed4-adc7-47f5-bfe1-96a0e933e834" }, { "id": "2e6a9ba7-b65c-4e15-ada5-02065039df0b", "name": "User doesn't have permission to assign tags.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/:endpoint_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", ":endpoint_id", "tags" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2e6a9ba7-b65c-4e15-ada5-02065039df0b" }, { "id": "248b41b1-ca12-4411-acf0-a13b4886f464", "name": "The tag is already assigned.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/:endpoint_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", ":endpoint_id", "tags" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-248b41b1-ca12-4411-acf0-a13b4886f464" }, { "id": "9c905786-0dd1-4333-afc1-602e01df51b7", "name": "Unprocessable entity.\nSee HTTP response body for details.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/endpoint/:endpoint_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "endpoint", ":endpoint_id", "tags" ], "variable": [ { "key": "endpoint_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9c905786-0dd1-4333-afc1-602e01df51b7" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f15824f3-7b3b-4514-a0f1-cf902cd61026" } ], "id": "cf441483-e546-422d-9294-1f9331343eb1", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cf441483-e546-422d-9294-1f9331343eb1" } ], "id": "845cb081-5274-4847-8f8d-c97e369b056b", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-845cb081-5274-4847-8f8d-c97e369b056b" } ], "id": "85d9eed2-dd04-4f16-8cdb-409f63384774", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-85d9eed2-dd04-4f16-8cdb-409f63384774" }, { "name": "tag-colors", "item": [ { "name": "Returns the list of available tag colors", "id": "1a624800-873e-492d-ba70-bdf50359193c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/tag-colors", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tag-colors" ] }, "description": "Returns the list of available tag colors" }, "response": [ { "id": "7886d678-cd30-4209-b4aa-b79553352651", "name": "Tag colors successfully listed.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/tag-colors", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tag-colors" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"hex_color\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"hex_color\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7886d678-cd30-4209-b4aa-b79553352651" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1a624800-873e-492d-ba70-bdf50359193c" } ], "id": "8a8ceb29-6116-4adb-b9b3-9e41224105dd", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8a8ceb29-6116-4adb-b9b3-9e41224105dd" }, { "name": "tags", "item": [ { "name": "{tag_id}", "item": [ { "name": "Delete a tag", "id": "bab75706-1fe7-4785-afba-391525f7c211", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/tags/:tag_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags", ":tag_id" ], "variable": [ { "id": "3fbdf4d7-1d94-4d2d-afbc-312d5136a83b", "key": "tag_id", "value": "", "description": "(Required) The tag ID" } ] }, "description": "Deletes a tag and it removes all associations with resources (for example, devices or automations).\n" }, "response": [ { "id": "3bede941-95bd-410d-9b22-511571e584ab", "name": "Tag successfully deleted.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/tags/:tag_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags", ":tag_id" ], "variable": [ { "key": "tag_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3bede941-95bd-410d-9b22-511571e584ab" }, { "id": "21f96548-d3da-49f8-864b-d685d252fe52", "name": "User doesn't have permission to delete tags.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/tags/:tag_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags", ":tag_id" ], "variable": [ { "key": "tag_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-21f96548-d3da-49f8-864b-d685d252fe52" }, { "id": "f17f2edb-4a9e-4efd-842d-8ad4858db12e", "name": "The provided tag ID doesn't exist.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/tags/:tag_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags", ":tag_id" ], "variable": [ { "key": "tag_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f17f2edb-4a9e-4efd-842d-8ad4858db12e" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-bab75706-1fe7-4785-afba-391525f7c211" }, { "name": "Update a tag", "id": "99dbeeaa-7976-43fb-8494-41b97e0553c7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/tags/:tag_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags", ":tag_id" ], "variable": [ { "id": "346bf075-aee9-4808-a2d8-1a892e88e35b", "key": "tag_id", "value": "", "description": "(Required) The tag ID" } ] }, "description": "Updates a tag with the provided name and color ID.\n" }, "response": [ { "id": "cd5356bd-3e0e-45f4-a8de-f2e5f700b940", "name": "Tag successfully updated.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/tags/:tag_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags", ":tag_id" ], "variable": [ { "key": "tag_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-cd5356bd-3e0e-45f4-a8de-f2e5f700b940" }, { "id": "713b530a-a2fe-4368-aef2-b5d1ddab7335", "name": "Invalid payload.\nSee HTTP response body for details.\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/tags/:tag_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags", ":tag_id" ], "variable": [ { "key": "tag_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-713b530a-a2fe-4368-aef2-b5d1ddab7335" }, { "id": "70137566-2374-478f-bfc6-84e5d4a265f2", "name": "User doesn't have permission to update tags.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/tags/:tag_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags", ":tag_id" ], "variable": [ { "key": "tag_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-70137566-2374-478f-bfc6-84e5d4a265f2" }, { "id": "d804f9a6-2df7-49a2-9323-d953f2e4518d", "name": "The provided tag ID doesn't exist.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/tags/:tag_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags", ":tag_id" ], "variable": [ { "key": "tag_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d804f9a6-2df7-49a2-9323-d953f2e4518d" }, { "id": "d5698769-a49a-49f3-8f29-9c2ad1945ba7", "name": "Unprocessable entity.\nSee HTTP response body for details.\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/tags/:tag_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags", ":tag_id" ], "variable": [ { "key": "tag_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d5698769-a49a-49f3-8f29-9c2ad1945ba7" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-99dbeeaa-7976-43fb-8494-41b97e0553c7" } ], "id": "b70a23f8-4779-47f8-8ead-5ababd3275db", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b70a23f8-4779-47f8-8ead-5ababd3275db" }, { "name": "List tags", "id": "1399098a-26d1-49b7-8902-cad79a25d904", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/tags?name=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags" ], "query": [ { "description": "The tag name", "key": "name", "value": "" }, { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "page_size", "value": "" } ] }, "description": "Returns a list of all registered tags within the organization.\n" }, "response": [ { "id": "ac4123e0-89eb-49df-a827-cd34981ec314", "name": "Tags successfully listed.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/tags?name=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags" ], "query": [ { "description": "The tag name", "key": "name", "value": "" }, { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "page_size", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total\": \"\",\n \"page\": \"\",\n \"page_size\": \"\",\n \"last_page\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"resource_count\": \"\",\n \"tag_color\": {\n \"id\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"resource_count\": \"\",\n \"tag_color\": {\n \"id\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ac4123e0-89eb-49df-a827-cd34981ec314" }, { "id": "8251a6c1-2412-4672-bc42-93b02153a3e2", "name": "Invalid payload.\nSee HTTP response body for details.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/tags?name=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags" ], "query": [ { "description": "The tag name", "key": "name", "value": "" }, { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "page_size", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8251a6c1-2412-4672-bc42-93b02153a3e2" }, { "id": "9a81de03-f841-48e1-b8dd-842cbe36fbfa", "name": "User doesn't have permission to list tags.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/tags?name=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags" ], "query": [ { "description": "The tag name", "key": "name", "value": "" }, { "description": "Current page number", "key": "page", "value": "" }, { "description": "Defines the number of items per page", "key": "page_size", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9a81de03-f841-48e1-b8dd-842cbe36fbfa" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1399098a-26d1-49b7-8902-cad79a25d904" }, { "name": "Create a tag", "id": "afb3caa3-17d8-4299-98e5-f43c3fabe4e5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags" ] }, "description": "Creates a tag with the given name and color ID.\n\nIf no color ID is provided, a random color is assigned to the tag.\n" }, "response": [ { "id": "e315e8b3-e088-461f-afe7-f4f635cb34fb", "name": "Tag successfully created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"tag_color\": {\n \"id\": \"\"\n }\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e315e8b3-e088-461f-afe7-f4f635cb34fb" }, { "id": "abbbd0b9-004c-4270-9a11-8fd1fef9f902", "name": "Invalid payload.\nSee HTTP response body for details.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-abbbd0b9-004c-4270-9a11-8fd1fef9f902" }, { "id": "2c9a6785-b17b-4e43-9ed9-d2bc62f73112", "name": "User doesn't have permission to create tags.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2c9a6785-b17b-4e43-9ed9-d2bc62f73112" }, { "id": "d2291668-776d-4e93-a839-42ae42a82dc1", "name": "The tag already exists.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d2291668-776d-4e93-a839-42ae42a82dc1" }, { "id": "15c32a71-7983-4031-91ef-19ad5623518e", "name": "Unprocessable entity.\nSee HTTP response body for details.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"error_token\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-15c32a71-7983-4031-91ef-19ad5623518e" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-afb3caa3-17d8-4299-98e5-f43c3fabe4e5" } ], "id": "8dba2b46-0504-4bb2-bbd7-704b22c7eba7", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8dba2b46-0504-4bb2-bbd7-704b22c7eba7" }, { "name": "tariff_profile", "item": [ { "name": "{tariff_profile_id}", "item": [ { "name": "operator_blocklist", "item": [ { "name": "operator", "item": [ { "name": "{operator_id}", "item": [ { "name": "rat_type", "item": [ { "name": "{rate_type_id}", "item": [ { "name": "Unblock a specific RAT type", "id": "584dc966-806b-458d-8f2e-c6eef242f2bd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/tariff_profile/:tariff_profile_id/operator_blocklist/operator/:operator_id/rat_type/:rate_type_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tariff_profile", ":tariff_profile_id", "operator_blocklist", "operator", ":operator_id", "rat_type", ":rate_type_id" ], "variable": [ { "id": "080dd101-f466-4888-a6d4-c872cfa7e83d", "key": "tariff_profile_id", "value": "", "description": "(Required) " }, { "id": "f726353d-8be8-4e48-8a3b-5f111e46974b", "key": "operator_id", "value": "", "description": "(Required) " }, { "id": "8f535409-6c0c-4d69-a04f-c8c9672b585f", "key": "rate_type_id", "value": "", "description": "(Required) " } ] }, "description": "Unblock a specific RAT type for an operator within a tariff profile." }, "response": [ { "id": "00477b2e-8937-43d8-949b-6047561484b3", "name": "No Content - The specific RAT type has been successfully unblocked.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/tariff_profile/:tariff_profile_id/operator_blocklist/operator/:operator_id/rat_type/:rate_type_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tariff_profile", ":tariff_profile_id", "operator_blocklist", "operator", ":operator_id", "rat_type", ":rate_type_id" ], "variable": [ { "key": "tariff_profile_id" }, { "key": "operator_id" }, { "key": "rate_type_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-00477b2e-8937-43d8-949b-6047561484b3" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-584dc966-806b-458d-8f2e-c6eef242f2bd" } ], "id": "95d70198-ad2a-4a1e-a22c-549323ec86b4", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-95d70198-ad2a-4a1e-a22c-549323ec86b4" }, { "name": "Block specific RAT types", "id": "7fdca43e-e5b7-4442-bb3e-0b05db163690", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"rat_types\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/tariff_profile/:tariff_profile_id/operator_blocklist/operator/:operator_id/rat_type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tariff_profile", ":tariff_profile_id", "operator_blocklist", "operator", ":operator_id", "rat_type" ], "variable": [ { "id": "5745f036-feff-49ab-9fed-62c07541c633", "key": "tariff_profile_id", "value": "", "description": "(Required) " }, { "id": "deb16fd2-6c2e-45fa-b9c9-53b9dfa592e8", "key": "operator_id", "value": "", "description": "(Required) " } ] }, "description": "Add a specific operator to the blocklist of a given tariff profile.\nIf the operator is already blocked completely, it is still possible to block specific RAT types.\n" }, "response": [ { "id": "1a2d2e4e-1916-4def-8cfe-8f7f8a1e9fcb", "name": "No Content - The specific RAT types have been successfully blocked.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"rat_types\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/tariff_profile/:tariff_profile_id/operator_blocklist/operator/:operator_id/rat_type", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tariff_profile", ":tariff_profile_id", "operator_blocklist", "operator", ":operator_id", "rat_type" ], "variable": [ { "key": "tariff_profile_id" }, { "key": "operator_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1a2d2e4e-1916-4def-8cfe-8f7f8a1e9fcb" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7fdca43e-e5b7-4442-bb3e-0b05db163690" } ], "id": "55d8d3e4-86b1-4ea8-820e-ad79aaee1031", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-55d8d3e4-86b1-4ea8-820e-ad79aaee1031" }, { "name": "Get operator blocklist for a specific tariff profile", "id": "8733b943-157f-4222-b95c-dd5486189009", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/tariff_profile/:tariff_profile_id/operator_blocklist/operator/:operator_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tariff_profile", ":tariff_profile_id", "operator_blocklist", "operator", ":operator_id" ], "variable": [ { "id": "b6a701f1-04a1-4e5d-83ef-11ba5a557205", "key": "tariff_profile_id", "value": "", "description": "(Required) " }, { "id": "85d164be-19fe-4bcb-9648-a7fec8a1d3e3", "key": "operator_id", "value": "", "description": "(Required) " } ] }, "description": "Retrieve blocklist details for an operator within a specific tariff profile" }, "response": [ { "id": "22e40b0c-423a-4253-b47c-af592fc39930", "name": "Successfully retrieved operator blocklist details", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/tariff_profile/:tariff_profile_id/operator_blocklist/operator/:operator_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tariff_profile", ":tariff_profile_id", "operator_blocklist", "operator", ":operator_id" ], "variable": [ { "key": "tariff_profile_id" }, { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"operator\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"blocklist\": {\n \"operator\": \"\",\n \"rat_types\": [\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-22e40b0c-423a-4253-b47c-af592fc39930" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8733b943-157f-4222-b95c-dd5486189009" }, { "name": "Block the operator completely for a given tariff profile", "id": "19dcfe0b-647c-4fed-a365-d4e39e10f461", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/tariff_profile/:tariff_profile_id/operator_blocklist/operator/:operator_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tariff_profile", ":tariff_profile_id", "operator_blocklist", "operator", ":operator_id" ], "variable": [ { "id": "8d8e9eb5-e66e-4d84-8ade-bb33a10152e7", "key": "tariff_profile_id", "value": "", "description": "(Required) " }, { "id": "4c2f9ce5-9811-440a-b401-4307ba1f9464", "key": "operator_id", "value": "", "description": "(Required) " } ] }, "description": "Block the operator completely.\nIf there are already specific RAT types blocklisted, those entries **aren't** overridden.\n\n\n You don't need a request body for this operation.\n\n" }, "response": [ { "id": "8d3fb150-0734-4a99-906c-1f239f9fb4bd", "name": "No Content. The operator has been successfully blocklisted.", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/tariff_profile/:tariff_profile_id/operator_blocklist/operator/:operator_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tariff_profile", ":tariff_profile_id", "operator_blocklist", "operator", ":operator_id" ], "variable": [ { "key": "tariff_profile_id" }, { "key": "operator_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8d3fb150-0734-4a99-906c-1f239f9fb4bd" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-19dcfe0b-647c-4fed-a365-d4e39e10f461" }, { "name": "Remove an operator from the blocklist", "id": "7ab3cac9-d849-47d5-a051-9a2fb2b31f1c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/tariff_profile/:tariff_profile_id/operator_blocklist/operator/:operator_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tariff_profile", ":tariff_profile_id", "operator_blocklist", "operator", ":operator_id" ], "variable": [ { "id": "279f2943-25f9-40c0-a88b-2c9e380da844", "key": "tariff_profile_id", "value": "", "description": "(Required) " }, { "id": "62c4c756-2b14-42c3-9bce-64af3acc8a3e", "key": "operator_id", "value": "", "description": "(Required) " } ] }, "description": "Removes a specific operator from the blocklist of a given tariff profile.\nIf there are already specific RAT types blocklisted, the entries will NOT be overridden.\n" }, "response": [ { "id": "83b3a106-0a15-4e0a-8493-b40fb79956c8", "name": "No Content - Operator successfully removed from the blocklist", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/tariff_profile/:tariff_profile_id/operator_blocklist/operator/:operator_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tariff_profile", ":tariff_profile_id", "operator_blocklist", "operator", ":operator_id" ], "variable": [ { "key": "tariff_profile_id" }, { "key": "operator_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-83b3a106-0a15-4e0a-8493-b40fb79956c8" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7ab3cac9-d849-47d5-a051-9a2fb2b31f1c" } ], "id": "423b3610-1a64-4677-af1a-e20f4031079f", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-423b3610-1a64-4677-af1a-e20f4031079f" }, { "name": "Get the operator blocklist for a specific tariff profile", "id": "a496fd23-f634-4ba3-a195-056794efc246", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/tariff_profile/:tariff_profile_id/operator_blocklist/operator", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tariff_profile", ":tariff_profile_id", "operator_blocklist", "operator" ], "variable": [ { "id": "e2d63495-bd42-46ef-bb6f-4a33e200bcef", "key": "tariff_profile_id", "value": "", "description": "(Required) " } ] }, "description": "Retrieve blocklist details for operators within a specific tariff profile" }, "response": [ { "id": "c4275c49-13b3-42c4-a6cc-4746e982246e", "name": "Successfully retrieved the operator blocklist", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/tariff_profile/:tariff_profile_id/operator_blocklist/operator", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tariff_profile", ":tariff_profile_id", "operator_blocklist", "operator" ], "variable": [ { "key": "tariff_profile_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"operator\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tariff_profile\": {\n \"id\": \"\"\n },\n \"blocklist\": {\n \"operator\": \"\",\n \"rat_types\": [\n {\n \"id\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c4275c49-13b3-42c4-a6cc-4746e982246e" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a496fd23-f634-4ba3-a195-056794efc246" } ], "id": "4f4f1d67-97cf-4285-9f5b-014f5d52914c", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-4f4f1d67-97cf-4285-9f5b-014f5d52914c" } ], "id": "09655cbd-4156-47d9-b23f-553002411111", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-09655cbd-4156-47d9-b23f-553002411111" } ], "id": "932961f2-dea2-4171-9716-0da68e279026", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-932961f2-dea2-4171-9716-0da68e279026" } ], "id": "2587cddd-4669-44a1-89b1-02dbc0b6885e", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2587cddd-4669-44a1-89b1-02dbc0b6885e" }, { "name": "user", "item": [ { "name": "activation", "item": [ { "name": "Accept user invitation", "id": "05854276-182a-422d-82be-d0fc5049fbcc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"activationKey\": \"\",\n \"password\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/user/activation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", "activation" ] }, "description": "Accepts a user invitation to join a Workspace.\n\nThe following fields may be provided:\n- `activationKey` (String, required) - the JWT token received in the verification email\n- `password` (String) - only mandatory if the user is invited to an organization without single sign-on (SSO) and doesn't have a password yet\n- `name` (String) - name of the user\n" }, "response": [ { "id": "513fd1e1-7bbf-4f65-92a5-2bbca54afef9", "name": "User successfully accepted the invitation", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"activationKey\": \"\",\n \"password\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/user/activation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", "activation" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-513fd1e1-7bbf-4f65-92a5-2bbca54afef9" }, { "id": "54994d8e-bcaa-470f-bf63-f0091cb1e1d4", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"activationKey\": \"\",\n \"password\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/user/activation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", "activation" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-54994d8e-bcaa-470f-bf63-f0091cb1e1d4" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-05854276-182a-422d-82be-d0fc5049fbcc" } ], "id": "bf67ba9e-63bc-426b-9532-d422e6841075", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-bf67ba9e-63bc-426b-9532-d422e6841075" }, { "name": "invitation", "item": [ { "name": "Invite a user", "id": "036d1729-88d0-4169-a040-85362abb2058", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"name\": \"\",\n \"organisation\": {\n \"id\": \"\"\n },\n \"roles\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/user/invitation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", "invitation" ] }, "description": "Invite a user to a Workspace by specifying username and the roles that the user will have in the organization.\nThis user is created and a `User invited` event is sent.\nThere is no additional action such as an email sent.\n\nThe following fields may be provided:\n- `username` (String) - Email of the invited user\n- `name` (String) - Name of the invited user\n- `organisation` (Object) - Defaults to the default Workspace of the requesting user\n- `roles` (Array) - Assigns the **Administrator** role by default\n\nIf the invited user doesn't exist, a new user is created and the `organisation.id` is their default Workspace.\nIf the invited user already exists, the user is assigned to the Workspace.\nThis fails if the Workspace feature isn't enabled on the target organization's tariff plan.\n" }, "response": [ { "id": "fd4778c4-08b0-4379-a7ae-7539de2765e0", "name": "User created successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"name\": \"\",\n \"organisation\": {\n \"id\": \"\"\n },\n \"roles\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/user/invitation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", "invitation" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"username\": \"\",\n \"name\": \"\",\n \"organisation\": {\n \"id\": \"\"\n },\n \"roles\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-fd4778c4-08b0-4379-a7ae-7539de2765e0" }, { "id": "0f7aafd9-6458-4690-a508-8f58bd084505", "name": "Some of the given parameters have invalid values, detailed description will be given in the response\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"name\": \"\",\n \"organisation\": {\n \"id\": \"\"\n },\n \"roles\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/user/invitation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", "invitation" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0f7aafd9-6458-4690-a508-8f58bd084505" }, { "id": "ee275cda-044a-4681-ade2-03ae5177184f", "name": "Current logged in user is not permitted to invite users.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"name\": \"\",\n \"organisation\": {\n \"id\": \"\"\n },\n \"roles\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/user/invitation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", "invitation" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ee275cda-044a-4681-ade2-03ae5177184f" }, { "id": "d510cc09-d16d-4579-b8f8-897989f643b7", "name": "There is already an active user with the same username, so this cannot be taken\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"name\": \"\",\n \"organisation\": {\n \"id\": \"\"\n },\n \"roles\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/user/invitation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", "invitation" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d510cc09-d16d-4579-b8f8-897989f643b7" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-036d1729-88d0-4169-a040-85362abb2058" } ], "id": "6a8744d1-8fa5-4a3c-a38a-30df3ffe08a7", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-6a8744d1-8fa5-4a3c-a38a-30df3ffe08a7" }, { "name": "{user_id}", "item": [ { "name": "default_organisation", "item": [ { "name": "{workspace_id}", "item": [ { "name": "Update a user's default Workspace", "id": "266c6fe4-33f9-4a14-8c28-31d4986399d4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/default_organisation/:workspace_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "default_organisation", ":workspace_id" ], "variable": [ { "id": "0dc0005c-a73c-4440-a09b-77c877ef3dec", "key": "user_id", "value": "", "description": "(Required) " }, { "id": "7392d991-9e02-4f19-86a8-d20961578ccb", "key": "workspace_id", "value": "", "description": "(Required) " } ] }, "description": "Update a user's default Workspace.\n\n\n You must have **Administrator** access in both the old and new default Workspaces to execute this call.\n\n" }, "response": [ { "id": "17804e24-cc33-494c-a036-4feb8cda047d", "name": "Successfully updated the default Workspace", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/default_organisation/:workspace_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "default_organisation", ":workspace_id" ], "variable": [ { "key": "user_id" }, { "key": "workspace_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-17804e24-cc33-494c-a036-4feb8cda047d" }, { "id": "ce66b1c8-4176-4e3b-ab37-7f83ab800090", "name": "Administrator role required on the selected Workspace", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/default_organisation/:workspace_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "default_organisation", ":workspace_id" ], "variable": [ { "key": "user_id" }, { "key": "workspace_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ce66b1c8-4176-4e3b-ab37-7f83ab800090" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-266c6fe4-33f9-4a14-8c28-31d4986399d4" } ], "id": "0bfd5de1-5150-4870-ae46-1860da3c1438", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0bfd5de1-5150-4870-ae46-1860da3c1438" } ], "id": "101a71c1-c696-4896-957e-aab56f8a0d5d", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-101a71c1-c696-4896-957e-aab56f8a0d5d" }, { "name": "support_token", "item": [ { "name": "Create support access token for given user", "id": "bdec8d58-13b3-41ba-b883-06610d142b96", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"3\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/support_token", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "support_token" ], "variable": [ { "id": "7a96869c-80ba-44f8-88c8-c2700e517293", "key": "user_id", "value": "", "description": "(Required) " } ] }, "description": "Create a bearer token that can be used to acces the portal as the target user. Additionally\nadmin or observer role can be selected. The role will not be applied to the user, only to the token.\n\nThe access can be made through cannel-partner hierarchies as well.\nAn event will be generated on the accessed organisation.\n" }, "response": [ { "id": "39017857-541b-4322-9fbb-da3f263b98e0", "name": "Support token successfully created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"3\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/support_token", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "support_token" ], "variable": [ { "key": "user_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"support_token\": \"\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-39017857-541b-4322-9fbb-da3f263b98e0" }, { "id": "1d1da6b3-7d1d-4b5b-8d18-582244d67eac", "name": "Will appear in these cases:\n- User does not have support role\n- User tries to create support token for his own user\n- User tries to access user of parent or outside the organisation child subtree\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"3\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/support_token", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "support_token" ], "variable": [ { "key": "user_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1d1da6b3-7d1d-4b5b-8d18-582244d67eac" }, { "id": "23cbc5da-75c1-48c2-84f1-770d08a3201b", "name": "Will appear in these cases:\n- User is not active\n- User does not exist\n- Organisation is not found or not enabled\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"3\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/support_token", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "support_token" ], "variable": [ { "key": "user_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-23cbc5da-75c1-48c2-84f1-770d08a3201b" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-bdec8d58-13b3-41ba-b883-06610d142b96" } ], "id": "3e6eebce-0028-42fc-93a2-3d5b30f76416", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-3e6eebce-0028-42fc-93a2-3d5b30f76416" }, { "name": "workspace", "item": [ { "name": "{workspace_id}", "item": [ { "name": "role", "item": [ { "name": "{role_id}", "item": [ { "name": "Assign a role to a Workspace user", "id": "aee48090-875b-4fd5-a6ef-a995ccfd98d8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace/:workspace_id/role/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace", ":workspace_id", "role", ":role_id" ], "variable": [ { "id": "c950a625-8be2-4f0d-910e-ece674b92192", "key": "user_id", "value": "", "description": "(Required) " }, { "id": "aedfa555-3de5-4e03-864b-d3e619b7a98e", "key": "workspace_id", "value": "", "description": "(Required) " }, { "id": "46e6b63d-da99-4e91-bdf9-4863ed2403f9", "key": "role_id", "value": "", "description": "(Required) " } ] }, "description": "Assign a role to a user in the requested Workspace.\n\n\n You must have **Administrator** access in the requested Workspace to modify user roles.\n **SuperAdmin** roles also can't be modified unless you're logged in to the main organization.\n\n" }, "response": [ { "id": "77634784-f8f9-4800-b9ef-606d777f6be5", "name": "Successfully assigned the role", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace/:workspace_id/role/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace", ":workspace_id", "role", ":role_id" ], "variable": [ { "key": "user_id" }, { "key": "workspace_id" }, { "key": "role_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-77634784-f8f9-4800-b9ef-606d777f6be5" }, { "id": "944ef5a7-6d22-4ea8-8a01-69c32d809eca", "name": "Modifying your own account isn't allowed", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace/:workspace_id/role/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace", ":workspace_id", "role", ":role_id" ], "variable": [ { "key": "user_id" }, { "key": "workspace_id" }, { "key": "role_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-944ef5a7-6d22-4ea8-8a01-69c32d809eca" }, { "id": "f1f1196f-d5c8-4b84-9ba4-f533bdced5d6", "name": "User isn't allowed to do that action", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace/:workspace_id/role/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace", ":workspace_id", "role", ":role_id" ], "variable": [ { "key": "user_id" }, { "key": "workspace_id" }, { "key": "role_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f1f1196f-d5c8-4b84-9ba4-f533bdced5d6" }, { "id": "99b3b445-83b4-40e5-8f97-582d5ce187f9", "name": "Administrator role required on the selected Workspace or missing permissions to update SuperAdmins", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace/:workspace_id/role/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace", ":workspace_id", "role", ":role_id" ], "variable": [ { "key": "user_id" }, { "key": "workspace_id" }, { "key": "role_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-99b3b445-83b4-40e5-8f97-582d5ce187f9" }, { "id": "b32a1f71-b769-4fad-a7d5-91cd5294442f", "name": "User not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace/:workspace_id/role/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace", ":workspace_id", "role", ":role_id" ], "variable": [ { "key": "user_id" }, { "key": "workspace_id" }, { "key": "role_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b32a1f71-b769-4fad-a7d5-91cd5294442f" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-aee48090-875b-4fd5-a6ef-a995ccfd98d8" }, { "name": "Remove a role from a Workspace user", "id": "37cde2f5-8bf3-4214-8507-9df190785bec", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace/:workspace_id/role/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace", ":workspace_id", "role", ":role_id" ], "variable": [ { "id": "2834f055-c1e5-4b0f-9094-8d20249dce03", "key": "user_id", "value": "", "description": "(Required) " }, { "id": "33821549-cc07-4b91-bd15-1e3a95cb1406", "key": "workspace_id", "value": "", "description": "(Required) " }, { "id": "e93fd5c6-b652-449c-bbb4-eda4e9908a55", "key": "role_id", "value": "", "description": "(Required) " } ] }, "description": "Remove a user's role in the requested Workspace.\n\n\n You must have **Administrator** access in the requested Workspace to modify user roles.\n **SuperAdmin** roles also can't be modified unless you're logged in to the main organization.\n\n" }, "response": [ { "id": "549ea5ea-29a8-4368-9fcd-179ec2e96769", "name": "Successfully removed the role", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace/:workspace_id/role/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace", ":workspace_id", "role", ":role_id" ], "variable": [ { "key": "user_id" }, { "key": "workspace_id" }, { "key": "role_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-549ea5ea-29a8-4368-9fcd-179ec2e96769" }, { "id": "a1559f65-cb67-4367-8faa-bd33a514f2c3", "name": "Modifying your own account isn't allowed", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace/:workspace_id/role/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace", ":workspace_id", "role", ":role_id" ], "variable": [ { "key": "user_id" }, { "key": "workspace_id" }, { "key": "role_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a1559f65-cb67-4367-8faa-bd33a514f2c3" }, { "id": "d0bae89b-e776-4edb-9025-b1dbd093e698", "name": "User isn't allowed to do that action", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace/:workspace_id/role/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace", ":workspace_id", "role", ":role_id" ], "variable": [ { "key": "user_id" }, { "key": "workspace_id" }, { "key": "role_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d0bae89b-e776-4edb-9025-b1dbd093e698" }, { "id": "a5e227a7-a837-4269-a680-af0ffef0aa59", "name": "Administrator role required on the selected Workspace or missing permissions to update SuperAdmins", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace/:workspace_id/role/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace", ":workspace_id", "role", ":role_id" ], "variable": [ { "key": "user_id" }, { "key": "workspace_id" }, { "key": "role_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-a5e227a7-a837-4269-a680-af0ffef0aa59" }, { "id": "2696c755-f99a-4f5d-8d22-858742ce9415", "name": "User not found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace/:workspace_id/role/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace", ":workspace_id", "role", ":role_id" ], "variable": [ { "key": "user_id" }, { "key": "workspace_id" }, { "key": "role_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2696c755-f99a-4f5d-8d22-858742ce9415" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-37cde2f5-8bf3-4214-8507-9df190785bec" } ], "id": "54dfffdf-9196-4383-bf26-886bfb9b69c1", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-54dfffdf-9196-4383-bf26-886bfb9b69c1" } ], "id": "e3fbb2c8-d485-4346-89f5-3c9a9ebe53fa", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-e3fbb2c8-d485-4346-89f5-3c9a9ebe53fa" }, { "name": "Unassign a Workspace", "id": "b9e3b8ed-51cf-4574-96ee-bf82d6a32df0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace/:workspace_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace", ":workspace_id" ], "variable": [ { "id": "c11e5675-0717-4ff8-9033-c47d33a9b641", "key": "user_id", "value": "", "description": "(Required) " }, { "id": "fc9e3c47-e1c4-4e62-99c0-a8c1f96610ed", "key": "workspace_id", "value": "", "description": "(Required) " } ] }, "description": "Unassign a Workspace from a user.\n\n- If the user is deleted from their default Workspace, the next active Workspace is assigned as the default Workspace.\n- **SuperAdmins** can't be removed unless you're logged in to the main organization.\n\n\n You must have **Administrator** access in the requested Workspace to remove users.\n\n" }, "response": [ { "id": "8a98dacf-a012-4832-8b4d-449ca10cbb9d", "name": "Successfully unassigned the Workspace", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace/:workspace_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace", ":workspace_id" ], "variable": [ { "key": "user_id" }, { "key": "workspace_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8a98dacf-a012-4832-8b4d-449ca10cbb9d" }, { "id": "2e7396c1-486b-4f79-83f2-0fbfe3ef143e", "name": "Administrator role required on the selected Workspace or missing permissions to update SuperAdmins", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace/:workspace_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace", ":workspace_id" ], "variable": [ { "key": "user_id" }, { "key": "workspace_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-2e7396c1-486b-4f79-83f2-0fbfe3ef143e" }, { "id": "b2df4c8c-d83c-4214-b7d2-e1b2ad832dad", "name": "Workspace not found or not accessible", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace/:workspace_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace", ":workspace_id" ], "variable": [ { "key": "user_id" }, { "key": "workspace_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b2df4c8c-d83c-4214-b7d2-e1b2ad832dad" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-b9e3b8ed-51cf-4574-96ee-bf82d6a32df0" }, { "name": "Update user status in a Workspace", "id": "9051b330-73ab-46ee-b2b5-4b7a8b411415", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace/:workspace_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace", ":workspace_id" ], "variable": [ { "id": "05df2f0d-d298-46d5-9e43-522188cb213f", "key": "user_id", "value": "", "description": "(Required) " }, { "id": "74c6ad14-2274-4f39-a58f-fb8749f0436a", "key": "workspace_id", "value": "", "description": "(Required) " } ] }, "description": "Update a user's status in the requested Workspace.\n\n- Allowed statuses: `ACTIVE` (1) and `SUSPENDED` (2)\n- If the user is suspended in their default Workspace, the next active Workspace is assigned as the default Workspace.\n\n\n You must have **Administrator** access in the requested Workspace to update user statuses.\n\n" }, "response": [ { "id": "ae654c4c-e517-4280-9f9e-890f2d80be34", "name": "Successfully updated the user status", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"status\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace/:workspace_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace", ":workspace_id" ], "variable": [ { "key": "user_id" }, { "key": "workspace_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ae654c4c-e517-4280-9f9e-890f2d80be34" }, { "id": "ef1cb26a-8cee-44f6-9111-b2e78177a20c", "name": "Administrator role required on the selected Workspace or missing permissions to update SuperAdmins", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"status\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace/:workspace_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace", ":workspace_id" ], "variable": [ { "key": "user_id" }, { "key": "workspace_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-ef1cb26a-8cee-44f6-9111-b2e78177a20c" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-9051b330-73ab-46ee-b2b5-4b7a8b411415" } ], "id": "7b283a84-ef69-4147-9382-b61de74a5dc0", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-7b283a84-ef69-4147-9382-b61de74a5dc0" }, { "name": "List assigned Workspaces", "id": "d5ddb7c5-07f1-40c8-afa6-0a63fc4f379b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace" ], "variable": [ { "id": "ad166893-9297-4aba-8e78-44ff3e5fa7ac", "key": "user_id", "value": "", "description": "(Required) " } ] }, "description": "Retrieve a list of the Workspaces assigned to a user.\n\n\n Only returns Workspaces where you have **Administrator** access.\n\n" }, "response": [ { "id": "bbfb4ecf-641d-42fc-8830-ebf85d6d0cd1", "name": "Successfully retrieved assigned Workspaces list", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": {\n \"status\": {\n \"id\": \"\"\n }\n },\n \"roles\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"owner\": \"\",\n \"default_workspace\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": {\n \"status\": {\n \"id\": \"\"\n }\n },\n \"roles\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"owner\": \"\",\n \"default_workspace\": \"\"\n }\n]", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-bbfb4ecf-641d-42fc-8830-ebf85d6d0cd1" }, { "id": "0f48b957-17f9-4182-8c8d-65296634b45e", "name": "Administrator role required on the selected Workspace", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/user/:user_id/workspace", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "user", ":user_id", "workspace" ], "variable": [ { "key": "user_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-0f48b957-17f9-4182-8c8d-65296634b45e" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-d5ddb7c5-07f1-40c8-afa6-0a63fc4f379b" } ], "id": "8dca5883-15b2-429a-985d-b4d511ea5386", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-8dca5883-15b2-429a-985d-b4d511ea5386" } ], "id": "33a602c5-72af-465e-97c4-b7a4be9a0698", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-33a602c5-72af-465e-97c4-b7a4be9a0698" } ], "id": "19cb4263-c635-422d-a18a-d3d378d3fc51", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-19cb4263-c635-422d-a18a-d3d378d3fc51" }, { "name": "workspace", "item": [ { "name": "stats", "item": [ { "name": "daily", "item": [ { "name": "Retrieve Workspace daily stats", "id": "1275c48d-284a-45e7-8f7b-bcd7cbb65f09", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/workspace/stats/daily?start_date=&end_date=&workspace_ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "workspace", "stats", "daily" ], "query": [ { "description": "Filters by start date, provided in a `YYYY-MM-DD` format.\n\n\n If you don't define an end date, the response will include 6 months of data, beginning on the current date.\n\n", "key": "start_date", "value": "" }, { "description": "Filters by end date, provided in an `YYYY-MM-DD` format.\n\n\n If you don't define a start date, the response will only return data from the month indicated in your end date.\n\n", "key": "end_date", "value": "" }, { "description": "Comma separated list of workspace IDs to filter the results for.\nIf not provided, the response will include all Workspaces you have access to.\n", "key": "workspace_ids", "value": "" } ] }, "description": "Retrieve the daily stats for your Workspaces.\n" }, "response": [ { "id": "dc4b935e-964f-44b8-8ab5-b4b962613d75", "name": "Successfully retrieved the daily Workspace stats", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/workspace/stats/daily?start_date=&end_date=&workspace_ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "workspace", "stats", "daily" ], "query": [ { "description": "Filters by start date, provided in a `YYYY-MM-DD` format.\n\n\n If you don't define an end date, the response will include 6 months of data, beginning on the current date.\n\n", "key": "start_date", "value": "" }, { "description": "Filters by end date, provided in an `YYYY-MM-DD` format.\n\n\n If you don't define a start date, the response will only return data from the month indicated in your end date.\n\n", "key": "end_date", "value": "" }, { "description": "Comma separated list of workspace IDs to filter the results for.\nIf not provided, the response will include all Workspaces you have access to.\n", "key": "workspace_ids", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"days\": [\n {\n \"date\": \"\",\n \"sms_volume\": {\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"cost\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n },\n \"data_volume\": {\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"cost\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n },\n \"sat_geo_data_volume\": {\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"cost\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n },\n \"sat_geo_sms_volume\": {\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"cost\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n }\n },\n {\n \"date\": \"\",\n \"sms_volume\": {\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"cost\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n },\n \"data_volume\": {\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"cost\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n },\n \"sat_geo_data_volume\": {\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"cost\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n },\n \"sat_geo_sms_volume\": {\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"cost\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n }\n }\n ],\n \"total\": {\n \"data_volume\": {\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"cost\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n },\n \"sms_volume\": {\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"cost\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n },\n \"sat_geo_data_volume\": {\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"cost\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n },\n \"sat_geo_sms_volume\": {\n \"volume\": \"\",\n \"volume_tx\": \"\",\n \"volume_rx\": \"\",\n \"cost\": \"\",\n \"traffic_type\": {\n \"description\": \"\",\n \"unit\": \"\",\n \"id\": \"\"\n },\n \"currency\": {\n \"code\": \"\",\n \"symbol\": \"\",\n \"id\": \"\"\n }\n }\n }\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-dc4b935e-964f-44b8-8ab5-b4b962613d75" }, { "id": "f922c6cf-50fc-496e-b5dd-60b214773f22", "name": "Requested Workspaces not found or not accessible", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/workspace/stats/daily?start_date=&end_date=&workspace_ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "workspace", "stats", "daily" ], "query": [ { "description": "Filters by start date, provided in a `YYYY-MM-DD` format.\n\n\n If you don't define an end date, the response will include 6 months of data, beginning on the current date.\n\n", "key": "start_date", "value": "" }, { "description": "Filters by end date, provided in an `YYYY-MM-DD` format.\n\n\n If you don't define a start date, the response will only return data from the month indicated in your end date.\n\n", "key": "end_date", "value": "" }, { "description": "Comma separated list of workspace IDs to filter the results for.\nIf not provided, the response will include all Workspaces you have access to.\n", "key": "workspace_ids", "value": "" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"Any type\"\n}", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f922c6cf-50fc-496e-b5dd-60b214773f22" } ], "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1275c48d-284a-45e7-8f7b-bcd7cbb65f09" } ], "id": "15eed49a-f4a2-4a8f-84e7-1f0423c107d0", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-15eed49a-f4a2-4a8f-84e7-1f0423c107d0" } ], "id": "f16919e4-b168-481a-bda9-6fdcf7f3da39", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-f16919e4-b168-481a-bda9-6fdcf7f3da39" } ], "id": "10d875f3-7c55-4638-9456-69e14f1d6efe", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-10d875f3-7c55-4638-9456-69e14f1d6efe" } ], "id": "1ec88b49-db8d-495d-80c1-8bbd1f7d6e9a", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-1ec88b49-db8d-495d-80c1-8bbd1f7d6e9a" } ], "id": "c537bb03-02be-4d17-8871-9b4c284835e3", "createdAt": "2026-06-05T15:08:23.000Z", "updatedAt": "2026-06-05T15:08:23.000Z", "uid": "35240-c537bb03-02be-4d17-8871-9b4c284835e3" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://cdn.emnify.net" } ] }