{ "item": [ { "name": "Health", "description": { "content": "Service health and readiness probes.", "type": "text/plain" }, "item": [ { "name": "Health check", "request": { "name": "Health check", "description": {}, "url": { "path": [ "up" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "OK", "originalRequest": { "url": { "path": [ "up" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "up" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Health check (k8s)", "request": { "name": "Health check (k8s)", "description": {}, "url": { "path": [ "healthz" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "OK", "originalRequest": { "url": { "path": [ "healthz" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "healthz" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Auth", "description": { "content": "Authentication and session bootstrap endpoints.", "type": "text/plain" }, "item": [ { "name": "Password login", "request": { "name": "Password login", "description": {}, "url": { "path": [ "api", "v1", "auth", "password-login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Logged in", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "password-login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Bad request", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "password-login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "password-login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Request OTP", "request": { "name": "Request OTP", "description": {}, "url": { "path": [ "api", "v1", "auth", "request-otp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"purpose\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "OTP requested", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "request-otp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"purpose\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Bad request", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "request-otp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"purpose\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "request-otp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"purpose\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Verify OTP", "request": { "name": "Verify OTP", "description": {}, "url": { "path": [ "api", "v1", "auth", "verify-otp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"otp_code\": \"\",\n \"purpose\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Verified", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "verify-otp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"otp_code\": \"\",\n \"purpose\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Bad request", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "verify-otp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"otp_code\": \"\",\n \"purpose\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "verify-otp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"otp_code\": \"\",\n \"purpose\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Forgot password", "request": { "name": "Forgot password", "description": {}, "url": { "path": [ "api", "v1", "auth", "forgot-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Always success (anti-enumeration)", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "forgot-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "forgot-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Reset password", "request": { "name": "Reset password", "description": {}, "url": { "path": [ "api", "v1", "auth", "reset-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"reset_password_token\": \"\",\n \"token\": \"\",\n \"password_confirmation\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Password updated", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "reset-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"reset_password_token\": \"\",\n \"token\": \"\",\n \"password_confirmation\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Bad request", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "reset-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"reset_password_token\": \"\",\n \"token\": \"\",\n \"password_confirmation\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "reset-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"reset_password_token\": \"\",\n \"token\": \"\",\n \"password_confirmation\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Confirm email", "request": { "name": "Confirm email", "description": {}, "url": { "path": [ "api", "v1", "auth", "confirm-email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"confirmation_token\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Confirmed", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "confirm-email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"confirmation_token\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "confirm-email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"confirmation_token\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Logout (JWT)", "request": { "name": "Logout (JWT)", "description": {}, "url": { "path": [ "api", "v1", "auth", "logout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Logged out", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "logout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "logout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Current user (JWT)", "request": { "name": "Current user (JWT)", "description": {}, "url": { "path": [ "api", "v1", "auth", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "User payload", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update current user (JWT)", "request": { "name": "Update current user (JWT)", "description": {}, "url": { "path": [ "api", "v1", "auth", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Updated", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Dashboard", "description": { "content": "Operational dashboard and summary endpoints.", "type": "text/plain" }, "item": [ { "name": "Dashboard stats", "request": { "name": "Dashboard stats", "description": {}, "url": { "path": [ "api", "v1", "dashboard", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Stats", "originalRequest": { "url": { "path": [ "api", "v1", "dashboard", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "dashboard", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "dashboard", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Partners", "description": { "content": "Partner management endpoints.", "type": "text/plain" }, "item": [ { "name": "List partners (super_admin)", "request": { "name": "List partners (super_admin)", "description": {}, "url": { "path": [ "api", "v1", "partners" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Partner list", "originalRequest": { "url": { "path": [ "api", "v1", "partners" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "partners" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "partners" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create partner (super_admin)", "request": { "name": "Create partner (super_admin)", "description": {}, "url": { "path": [ "api", "v1", "partners" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created", "originalRequest": { "url": { "path": [ "api", "v1", "partners" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "partners" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get partner", "request": { "name": "Get partner", "description": {}, "url": { "path": [ "api", "v1", "partners", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Partner", "originalRequest": { "url": { "path": [ "api", "v1", "partners", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "partners", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update partner", "request": { "name": "Update partner", "description": {}, "url": { "path": [ "api", "v1", "partners", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Updated", "originalRequest": { "url": { "path": [ "api", "v1", "partners", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "partners", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "BillingEntities", "description": { "content": "Billing entity configuration and lifecycle.", "type": "text/plain" }, "item": [ { "name": "List billing entities (super_admin)", "request": { "name": "List billing entities (super_admin)", "description": {}, "url": { "path": [ "api", "v1", "billing_entities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Entities", "originalRequest": { "url": { "path": [ "api", "v1", "billing_entities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing_entities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create billing entity (super_admin)", "request": { "name": "Create billing entity (super_admin)", "description": {}, "url": { "path": [ "api", "v1", "billing_entities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created", "originalRequest": { "url": { "path": [ "api", "v1", "billing_entities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing_entities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get billing entity", "request": { "name": "Get billing entity", "description": {}, "url": { "path": [ "api", "v1", "billing_entities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Entity", "originalRequest": { "url": { "path": [ "api", "v1", "billing_entities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing_entities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update billing entity", "request": { "name": "Update billing entity", "description": {}, "url": { "path": [ "api", "v1", "billing_entities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Updated", "originalRequest": { "url": { "path": [ "api", "v1", "billing_entities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing_entities", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Activate billing entity", "request": { "name": "Activate billing entity", "description": {}, "url": { "path": [ "api", "v1", "billing_entities", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Activated", "originalRequest": { "url": { "path": [ "api", "v1", "billing_entities", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing_entities", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Deactivate billing entity", "request": { "name": "Deactivate billing entity", "description": {}, "url": { "path": [ "api", "v1", "billing_entities", ":id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Deactivated", "originalRequest": { "url": { "path": [ "api", "v1", "billing_entities", ":id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing_entities", ":id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Tenants", "description": { "content": "Tenant listing and management endpoints.", "type": "text/plain" }, "item": [ { "name": "List tenants", "request": { "name": "List tenants", "description": {}, "url": { "path": [ "api", "v1", "tenants" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Tenants", "originalRequest": { "url": { "path": [ "api", "v1", "tenants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "tenants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create tenant (JWT role-gated)", "request": { "name": "Create tenant (JWT role-gated)", "description": {}, "url": { "path": [ "api", "v1", "tenants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created", "originalRequest": { "url": { "path": [ "api", "v1", "tenants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "tenants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "tenants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Search tenants (typeahead)", "request": { "name": "Search tenants (typeahead)", "description": {}, "url": { "path": [ "api", "v1", "tenants", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Results", "originalRequest": { "url": { "path": [ "api", "v1", "tenants", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "tenants", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get tenant", "request": { "name": "Get tenant", "description": {}, "url": { "path": [ "api", "v1", "tenants", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Tenant", "originalRequest": { "url": { "path": [ "api", "v1", "tenants", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "tenants", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update tenant (JWT super_admin)", "request": { "name": "Update tenant (JWT super_admin)", "description": {}, "url": { "path": [ "api", "v1", "tenants", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Updated", "originalRequest": { "url": { "path": [ "api", "v1", "tenants", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "tenants", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Agents", "description": { "content": "Voice agent configuration and lifecycle.", "type": "text/plain" }, "item": [ { "name": "List agents", "request": { "name": "List agents", "description": {}, "url": { "path": [ "api", "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Cursor list", "originalRequest": { "url": { "path": [ "api", "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_cursor\": \"string\"\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": 2450.082913540753,\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create agent", "request": { "name": "Create agent", "description": {}, "url": { "path": [ "api", "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created", "originalRequest": { "url": { "path": [ "api", "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get agent", "request": { "name": "Get agent", "description": {}, "url": { "path": [ "api", "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Agent", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update agent", "request": { "name": "Update agent", "description": {}, "url": { "path": [ "api", "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Updated", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get published agent config", "request": { "name": "Get published agent config", "description": {}, "url": { "path": [ "api", "v1", "agents", ":id", "published" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Published config", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id", "published" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id", "published" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Agent phone numbers", "request": { "name": "Agent phone numbers", "description": {}, "url": { "path": [ "api", "v1", "agents", ":id", "phone_numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Numbers", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id", "phone_numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id", "phone_numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Clone agent", "request": { "name": "Clone agent", "description": {}, "url": { "path": [ "api", "v1", "agents", ":id", "clone" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Cloned", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id", "clone" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id", "clone" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Activate agent (alias publish)", "request": { "name": "Activate agent (alias publish)", "description": {}, "url": { "path": [ "api", "v1", "agents", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Activated", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Deactivate agent (alias unpublish)", "request": { "name": "Deactivate agent (alias unpublish)", "description": {}, "url": { "path": [ "api", "v1", "agents", ":id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Deactivated", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Publish agent", "request": { "name": "Publish agent", "description": {}, "url": { "path": [ "api", "v1", "agents", ":id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Published", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Unpublish agent", "request": { "name": "Unpublish agent", "description": {}, "url": { "path": [ "api", "v1", "agents", ":id", "unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Unpublished", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id", "unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id", "unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Attach phone number", "request": { "name": "Attach phone number", "description": {}, "url": { "path": [ "api", "v1", "agents", ":id", "attach_phone_number" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"phone_number_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Attached", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id", "attach_phone_number" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone_number_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Conflict", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id", "attach_phone_number" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone_number_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id", "attach_phone_number" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone_number_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Detach phone number", "request": { "name": "Detach phone number", "description": {}, "url": { "path": [ "api", "v1", "agents", ":id", "detach_phone_number" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"phone_number_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Detached", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id", "detach_phone_number" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone_number_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "agents", ":id", "detach_phone_number" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phone_number_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "TenantTools", "description": { "content": "Tenant tool definitions and runtime helpers.", "type": "text/plain" }, "item": [ { "name": "List tenant tools", "request": { "name": "List tenant tools", "description": {}, "url": { "path": [ "api", "v1", "tenant_tools" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Cursor list", "originalRequest": { "url": { "path": [ "api", "v1", "tenant_tools" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_cursor\": \"string\"\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": 2450.082913540753,\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "tenant_tools" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create tenant tool", "request": { "name": "Create tenant tool", "description": {}, "url": { "path": [ "api", "v1", "tenant_tools" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created", "originalRequest": { "url": { "path": [ "api", "v1", "tenant_tools" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "tenant_tools" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Test tool configuration", "request": { "name": "Test tool configuration", "description": {}, "url": { "path": [ "api", "v1", "tenant_tools", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Test result", "originalRequest": { "url": { "path": [ "api", "v1", "tenant_tools", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "tenant_tools", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get tenant tool", "request": { "name": "Get tenant tool", "description": {}, "url": { "path": [ "api", "v1", "tenant_tools", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Tool", "originalRequest": { "url": { "path": [ "api", "v1", "tenant_tools", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "tenant_tools", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update tenant tool", "request": { "name": "Update tenant tool", "description": {}, "url": { "path": [ "api", "v1", "tenant_tools", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Updated", "originalRequest": { "url": { "path": [ "api", "v1", "tenant_tools", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "tenant_tools", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Delete tenant tool", "request": { "name": "Delete tenant tool", "description": {}, "url": { "path": [ "api", "v1", "tenant_tools", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Deleted", "originalRequest": { "url": { "path": [ "api", "v1", "tenant_tools", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "tenant_tools", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Clone tool", "request": { "name": "Clone tool", "description": {}, "url": { "path": [ "api", "v1", "tenant_tools", ":id", "clone" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Cloned", "originalRequest": { "url": { "path": [ "api", "v1", "tenant_tools", ":id", "clone" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "tenant_tools", ":id", "clone" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Activate tool", "request": { "name": "Activate tool", "description": {}, "url": { "path": [ "api", "v1", "tenant_tools", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Activated", "originalRequest": { "url": { "path": [ "api", "v1", "tenant_tools", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "tenant_tools", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Deactivate tool", "request": { "name": "Deactivate tool", "description": {}, "url": { "path": [ "api", "v1", "tenant_tools", ":id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Deactivated", "originalRequest": { "url": { "path": [ "api", "v1", "tenant_tools", ":id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "tenant_tools", ":id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "PhoneNumbers", "description": { "content": "Phone number inventory and provider operations.", "type": "text/plain" }, "item": [ { "name": "List phone numbers", "request": { "name": "List phone numbers", "description": {}, "url": { "path": [ "api", "v1", "phone_numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Cursor list", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_cursor\": \"string\"\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": 2450.082913540753,\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create phone number", "request": { "name": "Create phone number", "description": {}, "url": { "path": [ "api", "v1", "phone_numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Bad request", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get phone number", "request": { "name": "Get phone number", "description": {}, "url": { "path": [ "api", "v1", "phone_numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Phone number", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update phone number", "request": { "name": "Update phone number", "description": {}, "url": { "path": [ "api", "v1", "phone_numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Updated", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Activate phone number", "request": { "name": "Activate phone number", "description": {}, "url": { "path": [ "api", "v1", "phone_numbers", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Activated", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Deactivate phone number", "request": { "name": "Deactivate phone number", "description": {}, "url": { "path": [ "api", "v1", "phone_numbers", ":id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Deactivated", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", ":id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", ":id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List available numbers", "request": { "name": "List available numbers", "description": {}, "url": { "path": [ "api", "v1", "phone_numbers", "available" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Available numbers", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", "available" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", "available" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List owned numbers", "request": { "name": "List owned numbers", "description": {}, "url": { "path": [ "api", "v1", "phone_numbers", "owned" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Owned numbers", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", "owned" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", "owned" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Purchase numbers", "request": { "name": "Purchase numbers", "description": {}, "url": { "path": [ "api", "v1", "phone_numbers", "purchase" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Numbers purchased", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", "purchase" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", "purchase" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Import externally owned numbers", "request": { "name": "Import externally owned numbers", "description": {}, "url": { "path": [ "api", "v1", "phone_numbers", "import_owned" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Imported numbers", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", "import_owned" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", "import_owned" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Sync provider numbers", "request": { "name": "Sync provider numbers", "description": {}, "url": { "path": [ "api", "v1", "phone_numbers", "sync" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Sync queued", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", "sync" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", "sync" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get number pricing catalog", "request": { "name": "Get number pricing catalog", "description": {}, "url": { "path": [ "api", "v1", "phone_numbers", "pricing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Pricing catalog", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", "pricing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", "pricing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List supported phone number countries", "request": { "name": "List supported phone number countries", "description": {}, "url": { "path": [ "api", "v1", "phone_numbers", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Country list", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Release owned number", "request": { "name": "Release owned number", "description": {}, "url": { "path": [ "api", "v1", "phone_numbers", ":id", "release" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Number released", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", ":id", "release" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", ":id", "release" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Resync number configuration", "request": { "name": "Resync number configuration", "description": {}, "url": { "path": [ "api", "v1", "phone_numbers", ":id", "resync" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Number resync queued", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", ":id", "resync" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", ":id", "resync" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Configure number-level provider webhooks", "request": { "name": "Configure number-level provider webhooks", "description": {}, "url": { "path": [ "api", "v1", "phone_numbers", ":id", "configure_webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Webhooks configured", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", ":id", "configure_webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "phone_numbers", ":id", "configure_webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "TelephonyConnections", "description": { "content": "Telephony provider connection management.", "type": "text/plain" }, "item": [ { "name": "List telephony connections", "request": { "name": "List telephony connections", "description": {}, "url": { "path": [ "api", "v1", "telephony_connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Cursor list", "originalRequest": { "url": { "path": [ "api", "v1", "telephony_connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_cursor\": \"string\"\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": 2450.082913540753,\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "telephony_connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create telephony connection", "request": { "name": "Create telephony connection", "description": {}, "url": { "path": [ "api", "v1", "telephony_connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created", "originalRequest": { "url": { "path": [ "api", "v1", "telephony_connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "telephony_connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Telephony metadata", "request": { "name": "Telephony metadata", "description": {}, "url": { "path": [ "api", "v1", "telephony_connections", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Meta", "originalRequest": { "url": { "path": [ "api", "v1", "telephony_connections", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "telephony_connections", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get telephony connection", "request": { "name": "Get telephony connection", "description": {}, "url": { "path": [ "api", "v1", "telephony_connections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Connection", "originalRequest": { "url": { "path": [ "api", "v1", "telephony_connections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "telephony_connections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update telephony connection", "request": { "name": "Update telephony connection", "description": {}, "url": { "path": [ "api", "v1", "telephony_connections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Updated", "originalRequest": { "url": { "path": [ "api", "v1", "telephony_connections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "telephony_connections", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Activate telephony connection", "request": { "name": "Activate telephony connection", "description": {}, "url": { "path": [ "api", "v1", "telephony_connections", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Activated", "originalRequest": { "url": { "path": [ "api", "v1", "telephony_connections", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "telephony_connections", ":id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Deactivate telephony connection", "request": { "name": "Deactivate telephony connection", "description": {}, "url": { "path": [ "api", "v1", "telephony_connections", ":id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Deactivated", "originalRequest": { "url": { "path": [ "api", "v1", "telephony_connections", ":id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "telephony_connections", ":id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "VoiceSessions", "description": { "content": "Call log, transcript, and recording resources.", "type": "text/plain" }, "item": [ { "name": "List voice sessions (cursor)", "request": { "name": "List voice sessions (cursor)", "description": {}, "url": { "path": [ "api", "v1", "voice_sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page_size", "value": "50" }, { "disabled": false, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Cursor list", "originalRequest": { "url": { "path": [ "api", "v1", "voice_sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" }, { "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_cursor\": \"string\"\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": 2450.082913540753,\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "voice_sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" }, { "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get voice session", "request": { "name": "Get voice session", "description": {}, "url": { "path": [ "api", "v1", "voice_sessions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Session", "originalRequest": { "url": { "path": [ "api", "v1", "voice_sessions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "voice_sessions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Session usage events", "request": { "name": "Session usage events", "description": {}, "url": { "path": [ "api", "v1", "voice_sessions", ":id", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Events", "originalRequest": { "url": { "path": [ "api", "v1", "voice_sessions", ":id", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "voice_sessions", ":id", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Recording redirect", "request": { "name": "Recording redirect", "description": {}, "url": { "path": [ "api", "v1", "voice_sessions", ":id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v1", "voice_sessions", ":id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "Redirect to recording URL", "originalRequest": { "url": { "path": [ "api", "v1", "voice_sessions", ":id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Found", "code": 302, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "voice_sessions", ":id", "recording" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Call trace payload (role-sanitized)", "request": { "name": "Call trace payload (role-sanitized)", "description": { "content": "Returns trace events, debug, and usage events for a voice session. Tenant and partner callers receive customer-safe sanitized payloads. Internal platform users receive richer internal fields, and only super_admin receives unredacted secret-like values.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "voice_sessions", ":id", "call_trace" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Trace summary", "originalRequest": { "url": { "path": [ "api", "v1", "voice_sessions", ":id", "call_trace" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "voice_sessions", ":id", "call_trace" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Transcript PDF", "request": { "name": "Transcript PDF", "description": {}, "url": { "path": [ "api", "v1", "voice_sessions", ":id", "transcript_pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "PDF", "originalRequest": { "url": { "path": [ "api", "v1", "voice_sessions", ":id", "transcript_pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/pdf" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "voice_sessions", ":id", "transcript_pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List call log exports", "request": { "name": "List call log exports", "description": {}, "url": { "path": [ "api", "v1", "call-log-exports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Exports", "originalRequest": { "url": { "path": [ "api", "v1", "call-log-exports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "call-log-exports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create call log export", "request": { "name": "Create call log export", "description": {}, "url": { "path": [ "api", "v1", "call-log-exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created", "originalRequest": { "url": { "path": [ "api", "v1", "call-log-exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Accepted", "originalRequest": { "url": { "path": [ "api", "v1", "call-log-exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "call-log-exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get call log export", "request": { "name": "Get call log export", "description": {}, "url": { "path": [ "api", "v1", "call-log-exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Export", "originalRequest": { "url": { "path": [ "api", "v1", "call-log-exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "call-log-exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "call-log-exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Download call log export", "request": { "name": "Download call log export", "description": {}, "url": { "path": [ "api", "v1", "call-log-exports", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "text/csv" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "CSV", "originalRequest": { "url": { "path": [ "api", "v1", "call-log-exports", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "text/csv" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/csv" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "call-log-exports", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "call-log-exports", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "CallTraces", "description": { "content": "Call trace diagnostics and telemetry.", "type": "text/plain" }, "item": [ { "name": "Trace timeline (role-sanitized)", "request": { "name": "Trace timeline (role-sanitized)", "description": { "content": "Returns the per-event trace timeline for a voice session. Tenant and partner callers receive sanitized event data. Internal platform users receive richer internal trace data, with secret-like values redacted unless the caller is super_admin.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "voice_sessions", ":id", "trace" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Timeline", "originalRequest": { "url": { "path": [ "api", "v1", "voice_sessions", ":id", "trace" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "voice_sessions", ":id", "trace" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Trace stats (platform_admin, platform_support, super_admin)", "request": { "name": "Trace stats (platform_admin, platform_support, super_admin)", "description": {}, "url": { "path": [ "api", "v1", "voice_sessions", ":id", "trace", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Stats", "originalRequest": { "url": { "path": [ "api", "v1", "voice_sessions", ":id", "trace", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "voice_sessions", ":id", "trace", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List trace events (paginated, platform_admin/platform_support/super_admin)", "request": { "name": "List trace events (paginated, platform_admin/platform_support/super_admin)", "description": {}, "url": { "path": [ "api", "v1", "call_traces" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "per_page", "value": "50" }, { "disabled": false, "key": "from", "value": "", "description": "ISO8601 datetime or epoch seconds/millis." }, { "disabled": false, "key": "to", "value": "", "description": "ISO8601 datetime or epoch seconds/millis." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Paginated list", "originalRequest": { "url": { "path": [ "api", "v1", "call_traces" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" }, { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "call_traces" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" }, { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Aggregate trace stats (platform_admin/platform_support/super_admin)", "request": { "name": "Aggregate trace stats (platform_admin/platform_support/super_admin)", "description": {}, "url": { "path": [ "api", "v1", "call_traces", "aggregate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "from", "value": "", "description": "ISO8601 datetime or epoch seconds/millis." }, { "disabled": false, "key": "to", "value": "", "description": "ISO8601 datetime or epoch seconds/millis." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Aggregation", "originalRequest": { "url": { "path": [ "api", "v1", "call_traces", "aggregate" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "call_traces", "aggregate" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Usage", "description": { "content": "Usage reporting and cost summary endpoints.", "type": "text/plain" }, "item": [ { "name": "List usage events", "request": { "name": "List usage events", "description": {}, "url": { "path": [ "api", "v1", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Cursor list", "originalRequest": { "url": { "path": [ "api", "v1", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_cursor\": \"string\"\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": true,\n \"key_1\": \"string\"\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Users", "description": { "content": "User profile and membership endpoints.", "type": "text/plain" }, "item": [ { "name": "List users (JWT only)", "request": { "name": "List users (JWT only)", "description": {}, "url": { "path": [ "api", "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Users", "originalRequest": { "url": { "path": [ "api", "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get user", "request": { "name": "Get user", "description": {}, "url": { "path": [ "api", "v1", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "User", "originalRequest": { "url": { "path": [ "api", "v1", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update user status", "request": { "name": "Update user status", "description": {}, "url": { "path": [ "api", "v1", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Updated", "originalRequest": { "url": { "path": [ "api", "v1", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Resend confirmation email", "request": { "name": "Resend confirmation email", "description": {}, "url": { "path": [ "api", "v1", "users", ":id", "resend_confirmation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Sent", "originalRequest": { "url": { "path": [ "api", "v1", "users", ":id", "resend_confirmation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "users", ":id", "resend_confirmation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Send reset password email", "request": { "name": "Send reset password email", "description": {}, "url": { "path": [ "api", "v1", "users", ":id", "send_reset_password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Sent", "originalRequest": { "url": { "path": [ "api", "v1", "users", ":id", "send_reset_password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "users", ":id", "send_reset_password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "FilterableAttributes", "description": { "content": "Metadata and filter capability endpoints.", "type": "text/plain" }, "item": [ { "name": "List supported models (public)", "request": { "name": "List supported models (public)", "description": {}, "url": { "path": [ "api", "v1", "filterable_attributes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Models", "originalRequest": { "url": { "path": [ "api", "v1", "filterable_attributes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "filterable_attributes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Filterable attributes for model", "request": { "name": "Filterable attributes for model", "description": { "content": "Public for most models. `usage_event` requires authentication; tenant and partner API keys must have the corresponding usage-read permission.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "filterable_attributes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Attributes", "originalRequest": { "url": { "path": [ "api", "v1", "filterable_attributes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Bad request", "originalRequest": { "url": { "path": [ "api", "v1", "filterable_attributes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Assets", "description": { "content": "Asset upload and retrieval endpoints.", "type": "text/plain" }, "item": [ { "name": "List assets", "request": { "name": "List assets", "description": {}, "url": { "path": [ "api", "v1", "assets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Assets", "originalRequest": { "url": { "path": [ "api", "v1", "assets" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "assets" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create asset", "request": { "name": "Create asset", "description": {}, "url": { "path": [ "api", "v1", "assets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created", "originalRequest": { "url": { "path": [ "api", "v1", "assets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Bad request", "originalRequest": { "url": { "path": [ "api", "v1", "assets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "assets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get asset", "request": { "name": "Get asset", "description": {}, "url": { "path": [ "api", "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Asset", "originalRequest": { "url": { "path": [ "api", "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update asset", "request": { "name": "Update asset", "description": {}, "url": { "path": [ "api", "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Updated", "originalRequest": { "url": { "path": [ "api", "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Delete asset (soft)", "request": { "name": "Delete asset (soft)", "description": {}, "url": { "path": [ "api", "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Deleted", "originalRequest": { "url": { "path": [ "api", "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Serve asset body", "request": { "name": "Serve asset body", "description": {}, "url": { "path": [ "api", "v1", "assets", ":id", "serve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Asset bytes", "originalRequest": { "url": { "path": [ "api", "v1", "assets", ":id", "serve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "assets", ":id", "serve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "ApiKeys", "description": { "content": "API key management endpoints.", "type": "text/plain" }, "item": [ { "name": "Get API-key permission metadata (JWT only)", "request": { "name": "Get API-key permission metadata (JWT only)", "description": { "content": "Returns the allowed scopes, default scopes, opt-in scopes, and grouped UI metadata for either tenant or partner API keys.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "api_key_permissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "owner_type", "value": "", "description": "(Required) " } ], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Permission metadata", "originalRequest": { "url": { "path": [ "api", "v1", "api_key_permissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "owner_type", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "api_key_permissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "owner_type", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List API keys (JWT only)", "request": { "name": "List API keys (JWT only)", "description": {}, "url": { "path": [ "api", "v1", "api_keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Keys", "originalRequest": { "url": { "path": [ "api", "v1", "api_keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "api_keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create API key (JWT only)", "request": { "name": "Create API key (JWT only)", "description": { "content": "Omitting `scopes` uses the default tenant API-key permission set. Supplying `scopes` creates a custom permission set. Additional opt-in scopes are advertised by `GET /api/v1/api_key_permissions`.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "api_keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created", "originalRequest": { "url": { "path": [ "api", "v1", "api_keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "api_keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get API key", "request": { "name": "Get API key", "description": {}, "url": { "path": [ "api", "v1", "api_keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Key", "originalRequest": { "url": { "path": [ "api", "v1", "api_keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "api_keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update API key active state or scopes", "request": { "name": "Update API key active state or scopes", "description": { "content": "Send `active`, `scopes`, or both. Sending `scopes` replaces the saved scope set for the key. Empty arrays are rejected.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "api_keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Updated", "originalRequest": { "url": { "path": [ "api", "v1", "api_keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "api_keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Revoke API key", "request": { "name": "Revoke API key", "description": {}, "url": { "path": [ "api", "v1", "api_keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Revoked", "originalRequest": { "url": { "path": [ "api", "v1", "api_keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "api_keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Reveal tenant API key secret (JWT admin/operator only)", "request": { "name": "Reveal tenant API key secret (JWT admin/operator only)", "description": {}, "url": { "path": [ "api", "v1", "api_keys", ":id", "reveal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Secret revealed", "originalRequest": { "url": { "path": [ "api", "v1", "api_keys", ":id", "reveal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "api_keys", ":id", "reveal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List partner API keys (JWT only)", "request": { "name": "List partner API keys (JWT only)", "description": {}, "url": { "path": [ "api", "v1", "partners", ":partner_id", "api_keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Partner keys", "originalRequest": { "url": { "path": [ "api", "v1", "partners", ":partner_id", "api_keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "partners", ":partner_id", "api_keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create partner API key (JWT only)", "request": { "name": "Create partner API key (JWT only)", "description": { "content": "Omitting `scopes` uses the default partner API-key permission set. Additional opt-in scopes, including `billing:partner:allocate` and `call_traces:admin_read`, are advertised by `GET /api/v1/api_key_permissions`.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "partners", ":partner_id", "api_keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created", "originalRequest": { "url": { "path": [ "api", "v1", "partners", ":partner_id", "api_keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "partners", ":partner_id", "api_keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update partner API key active state or scopes", "request": { "name": "Update partner API key active state or scopes", "description": { "content": "Send `active`, `scopes`, or both. Sending `scopes` replaces the saved scope set for the key. Empty arrays are rejected.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "partners", ":partner_id", "api_keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Updated", "originalRequest": { "url": { "path": [ "api", "v1", "partners", ":partner_id", "api_keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "partners", ":partner_id", "api_keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"active\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Revoke partner API key", "request": { "name": "Revoke partner API key", "description": {}, "url": { "path": [ "api", "v1", "partners", ":partner_id", "api_keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Revoked", "originalRequest": { "url": { "path": [ "api", "v1", "partners", ":partner_id", "api_keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "partners", ":partner_id", "api_keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Reveal partner API key secret (JWT partner_admin/super_admin only)", "request": { "name": "Reveal partner API key secret (JWT partner_admin/super_admin only)", "description": {}, "url": { "path": [ "api", "v1", "partners", ":partner_id", "api_keys", ":id", "reveal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Secret revealed", "originalRequest": { "url": { "path": [ "api", "v1", "partners", ":partner_id", "api_keys", ":id", "reveal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "partners", ":partner_id", "api_keys", ":id", "reveal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Voices", "description": { "content": "Voice catalog and voice usage endpoints.", "type": "text/plain" }, "item": [ { "name": "List voices", "request": { "name": "List voices", "description": {}, "url": { "path": [ "api", "v1", "voices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Voices", "originalRequest": { "url": { "path": [ "api", "v1", "voices" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "voices" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create voice (super_admin)", "request": { "name": "Create voice (super_admin)", "description": {}, "url": { "path": [ "api", "v1", "voices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created", "originalRequest": { "url": { "path": [ "api", "v1", "voices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "voices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Seed voices (super_admin)", "request": { "name": "Seed voices (super_admin)", "description": {}, "url": { "path": [ "api", "v1", "voices", "seed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Seeded", "originalRequest": { "url": { "path": [ "api", "v1", "voices", "seed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "voices", "seed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get voice", "request": { "name": "Get voice", "description": {}, "url": { "path": [ "api", "v1", "voices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Voice", "originalRequest": { "url": { "path": [ "api", "v1", "voices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "voices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update voice (super_admin)", "request": { "name": "Update voice (super_admin)", "description": {}, "url": { "path": [ "api", "v1", "voices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Updated", "originalRequest": { "url": { "path": [ "api", "v1", "voices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "voices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Delete voice (soft, super_admin)", "request": { "name": "Delete voice (soft, super_admin)", "description": {}, "url": { "path": [ "api", "v1", "voices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Deleted", "originalRequest": { "url": { "path": [ "api", "v1", "voices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "voices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Generate sample audio (super_admin)", "request": { "name": "Generate sample audio (super_admin)", "description": {}, "url": { "path": [ "api", "v1", "voices", ":id", "generate_audio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Queued", "originalRequest": { "url": { "path": [ "api", "v1", "voices", ":id", "generate_audio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "voices", ":id", "generate_audio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Record voice usage", "request": { "name": "Record voice usage", "description": {}, "url": { "path": [ "api", "v1", "voices", ":id", "record_usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Recorded", "originalRequest": { "url": { "path": [ "api", "v1", "voices", ":id", "record_usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "voices", ":id", "record_usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Billing", "description": { "content": "Billing and wallet operations.", "type": "text/plain" }, "item": [ { "name": "Tenant usage (billing view)", "request": { "name": "Tenant usage (billing view)", "description": {}, "url": { "path": [ "api", "v1", "billing", "tenants", ":tenant_id", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tenant_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Usage", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "tenants", ":tenant_id", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tenant_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "tenants", ":tenant_id", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tenant_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Tenant billing summary", "request": { "name": "Tenant billing summary", "description": {}, "url": { "path": [ "api", "v1", "billing", "tenants", ":tenant_id", "billing_summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tenant_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Summary", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "tenants", ":tenant_id", "billing_summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tenant_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "tenants", ":tenant_id", "billing_summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tenant_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create usage event (partner_admin/super_admin)", "request": { "name": "Create usage event (partner_admin/super_admin)", "description": {}, "url": { "path": [ "api", "v1", "billing", "usage-events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "usage-events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "usage-events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Partner invoice breakdown", "request": { "name": "Partner invoice breakdown", "description": {}, "url": { "path": [ "api", "v1", "billing", "partners", ":partner_id", "invoice-breakdown" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "from", "value": "", "description": "ISO8601 datetime or epoch seconds/millis." }, { "disabled": false, "key": "to", "value": "", "description": "ISO8601 datetime or epoch seconds/millis." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Breakdown", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "partners", ":partner_id", "invoice-breakdown" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "partners", ":partner_id", "invoice-breakdown" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Tenant cost report (super_admin)", "request": { "name": "Tenant cost report (super_admin)", "description": {}, "url": { "path": [ "api", "v1", "billing", "tenant_cost_report" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "from", "value": "", "description": "ISO8601 datetime or epoch seconds/millis." }, { "disabled": false, "key": "to", "value": "", "description": "ISO8601 datetime or epoch seconds/millis." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Report", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "tenant_cost_report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "tenant_cost_report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Partner cost report", "request": { "name": "Partner cost report", "description": {}, "url": { "path": [ "api", "v1", "billing", "partner_cost_report" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "partner_id", "value": "" }, { "disabled": false, "key": "from", "value": "", "description": "ISO8601 datetime or epoch seconds/millis." }, { "disabled": false, "key": "to", "value": "", "description": "ISO8601 datetime or epoch seconds/millis." }, { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Report", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "partner_cost_report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "partner_id", "value": "" }, { "key": "from", "value": "" }, { "key": "to", "value": "" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "partner_cost_report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "partner_id", "value": "" }, { "key": "from", "value": "" }, { "key": "to", "value": "" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Credit report", "request": { "name": "Credit report", "description": {}, "url": { "path": [ "api", "v1", "billing", "credit-report" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "view", "value": "" }, { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Credit report", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "credit-report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "view", "value": "" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "credit-report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "view", "value": "" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List invoices", "request": { "name": "List invoices", "description": {}, "url": { "path": [ "api", "v1", "billing", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Invoices", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get invoice", "request": { "name": "Get invoice", "description": {}, "url": { "path": [ "api", "v1", "billing", "invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Invoice", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Invoice PDF", "request": { "name": "Invoice PDF", "description": {}, "url": { "path": [ "api", "v1", "billing", "invoices", ":id", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "PDF", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "invoices", ":id", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/pdf" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "invoices", ":id", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create recharge order", "request": { "name": "Create recharge order", "description": {}, "url": { "path": [ "api", "v1", "billing", "recharge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "recharge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "recharge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Allocate partner credits to a tenant", "request": { "name": "Allocate partner credits to a tenant", "description": { "content": "JWT partner admins may call this directly. Partner API keys may call this only when explicitly granted the `billing:partner:allocate` scope. Supports safe retries through the `Idempotency-Key` header.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "billing", "allocate-credits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "Idempotency-Key", "value": "", "description": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Allocated", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "allocate-credits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "key": "Idempotency-Key", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "allocate-credits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "key": "Idempotency-Key", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Idempotency conflict", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "allocate-credits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "key": "Idempotency-Key", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "allocate-credits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "key": "Idempotency-Key", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Deallocate tenant credits back to the partner wallet", "request": { "name": "Deallocate tenant credits back to the partner wallet", "description": { "content": "JWT-only endpoint. Supports safe retries through the `Idempotency-Key` header.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "billing", "deallocate-credits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "Idempotency-Key", "value": "", "description": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Deallocated", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "deallocate-credits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "key": "Idempotency-Key", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "deallocate-credits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "key": "Idempotency-Key", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Idempotency conflict", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "deallocate-credits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "key": "Idempotency-Key", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "deallocate-credits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "key": "Idempotency-Key", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Grant free prepaid credits (super_admin)", "request": { "name": "Grant free prepaid credits (super_admin)", "description": {}, "url": { "path": [ "api", "v1", "billing", "grant-free-prepaid-credits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"accountable_type\": \"\",\n \"accountable_id\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"issue_zero_value_invoice\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Granted", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "grant-free-prepaid-credits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountable_type\": \"\",\n \"accountable_id\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"issue_zero_value_invoice\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "grant-free-prepaid-credits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountable_type\": \"\",\n \"accountable_id\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"issue_zero_value_invoice\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List wallet transactions for a tenant or partner account", "request": { "name": "List wallet transactions for a tenant or partner account", "description": {}, "url": { "path": [ "api", "v1", "billing", "wallet-transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "accountable_type", "value": "", "description": "(Required) " }, { "disabled": false, "key": "accountable_id", "value": "", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Wallet transactions", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "wallet-transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "accountable_type", "value": "" }, { "key": "accountable_id", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "wallet-transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "accountable_type", "value": "" }, { "key": "accountable_id", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Tenant rate change history", "request": { "name": "Tenant rate change history", "description": {}, "url": { "path": [ "api", "v1", "billing", "tenants", ":tenant_id", "rate-change-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tenant_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Rate history", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "tenants", ":tenant_id", "rate-change-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tenant_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "tenants", ":tenant_id", "rate-change-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tenant_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Partner rate change history", "request": { "name": "Partner rate change history", "description": {}, "url": { "path": [ "api", "v1", "billing", "partners", ":partner_id", "rate-change-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Rate history", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "partners", ":partner_id", "rate-change-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "partners", ":partner_id", "rate-change-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "partner_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Verify recharge", "request": { "name": "Verify recharge", "description": {}, "url": { "path": [ "api", "v1", "billing", "recharge", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Verified", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "recharge", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "recharge", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Tenant usage summary", "request": { "name": "Tenant usage summary", "description": {}, "url": { "path": [ "api", "v1", "billing", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Usage summary", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Tenant billing summary", "request": { "name": "Tenant billing summary", "description": {}, "url": { "path": [ "api", "v1", "billing", "billing_summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Billing summary", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "billing_summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "billing_summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Tenant rate change history", "request": { "name": "Tenant rate change history", "description": {}, "url": { "path": [ "api", "v1", "billing", "rate-change-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Tenant rate history", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "rate-change-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "rate-change-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Campaigns", "description": { "content": "Campaign orchestration endpoints.", "type": "text/plain" }, "item": [ { "name": "List campaigns", "request": { "name": "List campaigns", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Campaign list", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create campaign", "request": { "name": "Create campaign", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Campaign created", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Compare campaigns", "request": { "name": "Compare campaigns", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", "compare" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ids[]", "value": "", "description": "(Required) " }, { "disabled": false, "key": "ids[]", "value": "", "description": "(Required) " } ], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Comparison payload", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", "compare" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids[]", "value": "" }, { "key": "ids[]", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", "compare" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids[]", "value": "" }, { "key": "ids[]", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", "compare" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids[]", "value": "" }, { "key": "ids[]", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get campaign", "request": { "name": "Get campaign", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Campaign detail", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update campaign", "request": { "name": "Update campaign", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Campaign updated", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List campaign tasks", "request": { "name": "List campaign tasks", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "per_page", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Task list", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Campaign analytics", "request": { "name": "Campaign analytics", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "from", "value": "", "description": "ISO8601 datetime or epoch seconds/millis." }, { "disabled": false, "key": "to", "value": "", "description": "ISO8601 datetime or epoch seconds/millis." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Analytics payload", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Campaign dispatch health", "request": { "name": "Campaign dispatch health", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "dispatch_health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Dispatch health payload", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "dispatch_health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "dispatch_health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Save campaign as template", "request": { "name": "Save campaign as template", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "save_as_template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Template saved", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "save_as_template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Template saved", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "save_as_template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "save_as_template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Download campaign results export", "request": { "name": "Download campaign results export", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "results_export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "CSV download", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "results_export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "results_export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Queue campaign export from campaign list filter", "request": { "name": "Queue campaign export from campaign list filter", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "from", "value": "", "description": "ISO8601 datetime or epoch seconds/millis." }, { "disabled": false, "key": "to", "value": "", "description": "ISO8601 datetime or epoch seconds/millis." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Export queued", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "" }, { "key": "to", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Preview campaign execution capacity", "request": { "name": "Preview campaign execution capacity", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", "capacity_preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Capacity preview", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", "capacity_preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", "capacity_preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Analyze campaign audience timezone readiness", "request": { "name": "Analyze campaign audience timezone readiness", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", "audience_timezone_analysis" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Audience timezone analysis", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", "audience_timezone_analysis" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", "audience_timezone_analysis" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Launch campaign", "request": { "name": "Launch campaign", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Campaign launched", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Pause campaign", "request": { "name": "Pause campaign", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Campaign paused", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Resume campaign", "request": { "name": "Resume campaign", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Campaign resumed", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Cancel campaign", "request": { "name": "Cancel campaign", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Campaign cancelled", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Clone campaign", "request": { "name": "Clone campaign", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "clone" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Campaign cloned", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "clone" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "clone" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get clone prefill payload", "request": { "name": "Get clone prefill payload", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "clone_prefill" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Clone prefill payload", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "clone_prefill" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "clone_prefill" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List campaign follow-up rules", "request": { "name": "List campaign follow-up rules", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "follow_up_rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Follow-up rules", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "follow_up_rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "follow_up_rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update campaign follow-up rules", "request": { "name": "Update campaign follow-up rules", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "follow_up_rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Follow-up rules updated", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "follow_up_rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "follow_up_rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List campaign follow-up rules (hyphen alias)", "request": { "name": "List campaign follow-up rules (hyphen alias)", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "follow-up-rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Follow-up rules", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "follow-up-rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "follow-up-rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update campaign follow-up rules (hyphen alias)", "request": { "name": "Update campaign follow-up rules (hyphen alias)", "description": {}, "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "follow-up-rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Follow-up rules updated", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "follow-up-rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "bulk_call_campaigns", ":id", "follow-up-rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "CampaignExports", "description": { "content": "Campaign export job endpoints.", "type": "text/plain" }, "item": [ { "name": "List campaign exports", "request": { "name": "List campaign exports", "description": {}, "url": { "path": [ "api", "v1", "campaign-exports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Export list", "originalRequest": { "url": { "path": [ "api", "v1", "campaign-exports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "campaign-exports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Queue campaign export", "request": { "name": "Queue campaign export", "description": {}, "url": { "path": [ "api", "v1", "campaign-exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Export queued", "originalRequest": { "url": { "path": [ "api", "v1", "campaign-exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "campaign-exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get campaign export", "request": { "name": "Get campaign export", "description": {}, "url": { "path": [ "api", "v1", "campaign-exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Export detail", "originalRequest": { "url": { "path": [ "api", "v1", "campaign-exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "campaign-exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Download campaign export file", "request": { "name": "Download campaign export file", "description": {}, "url": { "path": [ "api", "v1", "campaign-exports", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "CSV download", "originalRequest": { "url": { "path": [ "api", "v1", "campaign-exports", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "campaign-exports", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "campaign-exports", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Contacts", "description": { "content": "Contact lifecycle operations.", "type": "text/plain" }, "item": [ { "name": "List contacts", "request": { "name": "List contacts", "description": {}, "url": { "path": [ "api", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Contacts list", "originalRequest": { "url": { "path": [ "api", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create contact", "request": { "name": "Create contact", "description": {}, "url": { "path": [ "api", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Contact created", "originalRequest": { "url": { "path": [ "api", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Import contacts in bulk", "request": { "name": "Import contacts in bulk", "description": {}, "url": { "path": [ "api", "v1", "contacts", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "(Required) CSV file containing contacts." }, { "key": "column_mapping", "value": "", "type": "text", "description": "JSON string mapping CSV headers to contact fields." }, { "key": "options", "value": "", "type": "text", "description": "Optional JSON string for import flags and defaults." } ] } }, "response": [ { "name": "Contact import accepted", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CSV file containing contacts.", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "JSON string mapping CSV headers to contact fields.", "type": "text/plain" }, "key": "column_mapping", "value": "", "type": "text" }, { "description": { "content": "Optional JSON string for import flags and defaults.", "type": "text/plain" }, "key": "options", "value": "", "type": "text" } ] } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) CSV file containing contacts.", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "JSON string mapping CSV headers to contact fields.", "type": "text/plain" }, "key": "column_mapping", "value": "", "type": "text" }, { "description": { "content": "Optional JSON string for import flags and defaults.", "type": "text/plain" }, "key": "options", "value": "", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Export contacts", "request": { "name": "Export contacts", "description": {}, "url": { "path": [ "api", "v1", "contacts", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Contact export queued", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Find duplicate contacts", "request": { "name": "Find duplicate contacts", "description": {}, "url": { "path": [ "api", "v1", "contacts", "duplicates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Duplicate groups", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", "duplicates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", "duplicates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get contact", "request": { "name": "Get contact", "description": {}, "url": { "path": [ "api", "v1", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Contact detail", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update contact", "request": { "name": "Update contact", "description": {}, "url": { "path": [ "api", "v1", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Contact updated", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Delete contact", "request": { "name": "Delete contact", "description": {}, "url": { "path": [ "api", "v1", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Contact deleted", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Merge contact into another contact", "request": { "name": "Merge contact into another contact", "description": {}, "url": { "path": [ "api", "v1", "contacts", ":id", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Contact merged", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":id", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":id", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Export one contact's full data", "request": { "name": "Export one contact's full data", "description": {}, "url": { "path": [ "api", "v1", "contacts", ":id", "data_export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Contact data export", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":id", "data_export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":id", "data_export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Perform GDPR contact erasure", "request": { "name": "Perform GDPR contact erasure", "description": {}, "url": { "path": [ "api", "v1", "contacts", ":id", "gdpr_delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Contact erased", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":id", "gdpr_delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":id", "gdpr_delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Hard delete contact row", "request": { "name": "Hard delete contact row", "description": {}, "url": { "path": [ "api", "v1", "contacts", ":id", "hard_delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Contact permanently deleted", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":id", "hard_delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":id", "hard_delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "ContactImports", "description": { "content": "Contact import job endpoints.", "type": "text/plain" }, "item": [ { "name": "List contact imports", "request": { "name": "List contact imports", "description": {}, "url": { "path": [ "api", "v1", "contact-imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Contact imports", "originalRequest": { "url": { "path": [ "api", "v1", "contact-imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "contact-imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create contact import job", "request": { "name": "Create contact import job", "description": {}, "url": { "path": [ "api", "v1", "contact-imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Import created", "originalRequest": { "url": { "path": [ "api", "v1", "contact-imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "contact-imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get contact import status", "request": { "name": "Get contact import status", "description": {}, "url": { "path": [ "api", "v1", "contact-imports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Contact import detail", "originalRequest": { "url": { "path": [ "api", "v1", "contact-imports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "contact-imports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Download contact import error report", "request": { "name": "Download contact import error report", "description": {}, "url": { "path": [ "api", "v1", "contact-imports", ":id", "error_report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Error report file", "originalRequest": { "url": { "path": [ "api", "v1", "contact-imports", ":id", "error_report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "contact-imports", ":id", "error_report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "ContactExports", "description": { "content": "Contact export job endpoints.", "type": "text/plain" }, "item": [ { "name": "List contact exports", "request": { "name": "List contact exports", "description": {}, "url": { "path": [ "api", "v1", "contact-exports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Contact exports", "originalRequest": { "url": { "path": [ "api", "v1", "contact-exports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "contact-exports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create contact export job", "request": { "name": "Create contact export job", "description": {}, "url": { "path": [ "api", "v1", "contact-exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Contact export queued", "originalRequest": { "url": { "path": [ "api", "v1", "contact-exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "contact-exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get contact export job", "request": { "name": "Get contact export job", "description": {}, "url": { "path": [ "api", "v1", "contact-exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Contact export detail", "originalRequest": { "url": { "path": [ "api", "v1", "contact-exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "contact-exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Download contact export file", "request": { "name": "Download contact export file", "description": {}, "url": { "path": [ "api", "v1", "contact-exports", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Contact export file", "originalRequest": { "url": { "path": [ "api", "v1", "contact-exports", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "contact-exports", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "ContactSegments", "description": { "content": "Contact segmentation endpoints.", "type": "text/plain" }, "item": [ { "name": "List contact segments", "request": { "name": "List contact segments", "description": {}, "url": { "path": [ "api", "v1", "contact_segments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Segment list", "originalRequest": { "url": { "path": [ "api", "v1", "contact_segments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "contact_segments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create contact segment", "request": { "name": "Create contact segment", "description": {}, "url": { "path": [ "api", "v1", "contact_segments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Segment created", "originalRequest": { "url": { "path": [ "api", "v1", "contact_segments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "contact_segments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get contact segment", "request": { "name": "Get contact segment", "description": {}, "url": { "path": [ "api", "v1", "contact_segments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Segment detail", "originalRequest": { "url": { "path": [ "api", "v1", "contact_segments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "contact_segments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update contact segment", "request": { "name": "Update contact segment", "description": {}, "url": { "path": [ "api", "v1", "contact_segments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Segment updated", "originalRequest": { "url": { "path": [ "api", "v1", "contact_segments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "contact_segments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Delete contact segment", "request": { "name": "Delete contact segment", "description": {}, "url": { "path": [ "api", "v1", "contact_segments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Segment deleted", "originalRequest": { "url": { "path": [ "api", "v1", "contact_segments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "contact_segments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List contacts for one segment", "request": { "name": "List contacts for one segment", "description": {}, "url": { "path": [ "api", "v1", "contact_segments", ":id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "per_page", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Segment contacts", "originalRequest": { "url": { "path": [ "api", "v1", "contact_segments", ":id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "contact_segments", ":id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional tenant context selector for JWT/partner key callers.", "key": "X-Tenant-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Webhooks", "description": { "content": "Webhook ingress and relay endpoints.", "type": "text/plain" }, "item": [ { "name": "Razorpay webhook (signature verified)", "request": { "name": "Razorpay webhook (signature verified)", "description": { "content": "No JWT. Uses `X-Razorpay-Signature` header for verification.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "billing", "razorpay-webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "razorpay-webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "Invalid signature", "originalRequest": { "url": { "path": [ "api", "v1", "billing", "razorpay-webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Twilio TwiML webhook proxy", "request": { "name": "Twilio TwiML webhook proxy", "description": {}, "url": { "path": [ "api", "v1", "telephony", "twilio", "twiml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "key_0", "value": "7777.417702901213" }, { "disabled": false, "key": "key_1", "value": "false" }, { "disabled": false, "key": "key_2", "value": "true" } ] } }, "response": [ { "name": "TwiML XML", "originalRequest": { "url": { "path": [ "api", "v1", "telephony", "twilio", "twiml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "key_0", "value": "3669" }, { "disabled": false, "key": "key_1", "value": "8419" }, { "disabled": false, "key": "key_2", "value": "4460" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "telephony", "twilio", "twiml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "key_0", "value": "3669" }, { "disabled": false, "key": "key_1", "value": "8419" }, { "disabled": false, "key": "key_2", "value": "4460" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Bad gateway", "originalRequest": { "url": { "path": [ "api", "v1", "telephony", "twilio", "twiml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "key_0", "value": "3669" }, { "disabled": false, "key": "key_1", "value": "8419" }, { "disabled": false, "key": "key_2", "value": "4460" } ] } }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Receive generic telephony vendor webhook event", "request": { "name": "Receive generic telephony vendor webhook event", "description": {}, "url": { "path": [ "api", "v1", "webhooks", "telephony", ":vendor_slug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "vendor_slug", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "key_0", "value": "7777.417702901213" }, { "disabled": false, "key": "key_1", "value": "false" }, { "disabled": false, "key": "key_2", "value": "true" } ] } }, "response": [ { "name": "Event accepted", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", "telephony", ":vendor_slug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "vendor_slug", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "key_0", "value": "3669" }, { "disabled": false, "key": "key_1", "value": "8419" }, { "disabled": false, "key": "key_2", "value": "4460" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", "telephony", ":vendor_slug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "vendor_slug", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "key_0", "value": "3669" }, { "disabled": false, "key": "key_1", "value": "8419" }, { "disabled": false, "key": "key_2", "value": "4460" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Capture sample telephony vendor webhook payload for diagnostics", "request": { "name": "Capture sample telephony vendor webhook payload for diagnostics", "description": {}, "url": { "path": [ "api", "v1", "webhooks", "telephony", ":vendor_slug", "sample" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "vendor_slug", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "key_0", "value": "7777.417702901213" }, { "disabled": false, "key": "key_1", "value": "false" }, { "disabled": false, "key": "key_2", "value": "true" } ] } }, "response": [ { "name": "Sample captured", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", "telephony", ":vendor_slug", "sample" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "vendor_slug", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "key_0", "value": "3669" }, { "disabled": false, "key": "key_1", "value": "8419" }, { "disabled": false, "key": "key_2", "value": "4460" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", "telephony", ":vendor_slug", "sample" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "vendor_slug", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "key_0", "value": "3669" }, { "disabled": false, "key": "key_1", "value": "8419" }, { "disabled": false, "key": "key_2", "value": "4460" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "PartnerAPI", "description": { "content": "Partner namespace endpoints for multi-tenant operations.", "type": "text/plain" }, "item": [ { "name": "List partner tenants", "request": { "name": "List partner tenants", "description": {}, "url": { "path": [ "api", "v1", "partner", "tenants" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Partner-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "name": "Tenants", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "tenants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Partner-Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "tenants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Partner-Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": 7151.875017310463\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create partner tenant", "request": { "name": "Create partner tenant", "description": {}, "url": { "path": [ "api", "v1", "partner", "tenants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Partner-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "tenants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Partner-Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "tenants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Partner-Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List tenant agents (partner)", "request": { "name": "List tenant agents (partner)", "description": {}, "url": { "path": [ "api", "v1", "partner", "tenants", ":tenant_id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tenant_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Partner-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "name": "Agents", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "tenants", ":tenant_id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tenant_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Partner-Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "tenants", ":tenant_id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tenant_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Partner-Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create tenant agent (partner)", "request": { "name": "Create tenant agent (partner)", "description": {}, "url": { "path": [ "api", "v1", "partner", "tenants", ":tenant_id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tenant_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Partner-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"key_0\": 7777.417702901213,\n \"key_1\": false,\n \"key_2\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "tenants", ":tenant_id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tenant_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Partner-Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "tenants", ":tenant_id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tenant_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Partner-Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 3669,\n \"key_1\": 8419,\n \"key_2\": 4460\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List tenant API keys (partner)", "request": { "name": "List tenant API keys (partner)", "description": { "content": "Partner API keys must be explicitly granted the `partner_tenant_api_keys:read` scope to use this endpoint.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "partner", "tenants", ":tenant_id", "api_keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tenant_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Partner-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "name": "Keys", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "tenants", ":tenant_id", "api_keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tenant_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Partner-Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"key_0\": 8167.857538327764\n },\n \"message\": \"string\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"request_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "tenants", ":tenant_id", "api_keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tenant_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Partner-Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"error_code\": \"string\",\n \"request_id\": \"string\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6158.512430022568,\n \"key_3\": \"string\",\n \"key_4\": 7718.217397680487\n },\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api.callaro.ai", "key": "baseUrl" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "info": { "name": "Callaro API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Auto-generated from developer-docs/openapi.yaml. Do not edit manually." } }