{ "info": { "_postman_id": "219d13f9-e5c1-4ec7-9308-a3901cff807b", "name": "Webex Admin Address Book Search API", "description": "The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T11:13:56.000Z", "updatedAt": "2026-07-28T11:13:56.000Z", "lastUpdatedBy": "35240", "uid": "35240-219d13f9-e5c1-4ec7-9308-a3901cff807b" }, "item": [ { "name": "search", "item": [ { "name": "Search tasks", "id": "8de7655a-701c-45fc-9af7-d9cff6525f39", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/search?orgId=", "host": [ "{{baseUrl}}" ], "path": [ "search" ], "query": [ { "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ] }, "description": "The /search API is a GraphQL endpoint that enables customers to fetch data from Webex Contact Center.\n\n**Authentication & Authorization:**\n- **Required Scopes:** `cjp:config` or `cjp:config_read`\n- **Required Roles:** Administrator or Supervisor\n\nMandatory parameters are FROM and TO, which accept datetime in epoch format. The FROM parameter cannot be older than 36 months from the current time. The TO parameter, if given as a future time, will be set to the current time. Optional parameters such as filter and aggregation are accepted for each query.\n\nResponse Compression: For this API, response compression using gzip can be enabled by including the 'Accept-Encoding' header in the request with its value as 'gzip'. The response will be compressed only if its size exceeds 1 MB. If the header is not present in the request or if gzip is not listed as one of the encodings in the header's value (comma-separated encodings), then the API response will not be compressed, impacting latency as observed from clients." }, "response": [ { "id": "2cd9cd51-4258-45cc-8aa7-0ba03c0cef5b", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/search?orgId=", "host": [ "{{baseUrl}}" ], "path": [ "search" ], "query": [ { "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T11:13:57.000Z", "updatedAt": "2026-07-28T11:13:57.000Z", "uid": "35240-2cd9cd51-4258-45cc-8aa7-0ba03c0cef5b" }, { "id": "f61c3861-c80f-4d89-aeb0-1a1054a09e09", "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/search?orgId=", "host": [ "{{baseUrl}}" ], "path": [ "search" ], "query": [ { "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T11:13:57.000Z", "updatedAt": "2026-07-28T11:13:57.000Z", "uid": "35240-f61c3861-c80f-4d89-aeb0-1a1054a09e09" }, { "id": "5f22bc7a-f4b8-43c1-8ca6-eb6dc92739dd", "name": "Unauthorized Operation", "originalRequest": { "method": "POST", "header": [ { "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/search?orgId=", "host": [ "{{baseUrl}}" ], "path": [ "search" ], "query": [ { "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T11:13:57.000Z", "updatedAt": "2026-07-28T11:13:57.000Z", "uid": "35240-5f22bc7a-f4b8-43c1-8ca6-eb6dc92739dd" }, { "id": "2e85e12a-5515-43f2-b0bb-f8802bd0d533", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/search?orgId=", "host": [ "{{baseUrl}}" ], "path": [ "search" ], "query": [ { "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T11:13:57.000Z", "updatedAt": "2026-07-28T11:13:57.000Z", "uid": "35240-2e85e12a-5515-43f2-b0bb-f8802bd0d533" }, { "id": "d45115ab-9b0c-471e-aead-eaac81f9a583", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/search?orgId=", "host": [ "{{baseUrl}}" ], "path": [ "search" ], "query": [ { "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T11:13:57.000Z", "updatedAt": "2026-07-28T11:13:57.000Z", "uid": "35240-d45115ab-9b0c-471e-aead-eaac81f9a583" }, { "id": "d6da91f8-5915-4e5e-a6bd-3822785fd672", "name": "Conflict", "originalRequest": { "method": "POST", "header": [ { "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/search?orgId=", "host": [ "{{baseUrl}}" ], "path": [ "search" ], "query": [ { "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T11:13:57.000Z", "updatedAt": "2026-07-28T11:13:57.000Z", "uid": "35240-d6da91f8-5915-4e5e-a6bd-3822785fd672" }, { "id": "94eedb7d-9d69-4200-8472-908ac22d4b73", "name": "Content Too Large", "originalRequest": { "method": "POST", "header": [ { "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/search?orgId=", "host": [ "{{baseUrl}}" ], "path": [ "search" ], "query": [ { "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ] } }, "status": "Request Entity Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T11:13:57.000Z", "updatedAt": "2026-07-28T11:13:57.000Z", "uid": "35240-94eedb7d-9d69-4200-8472-908ac22d4b73" }, { "id": "8237462a-ea2b-448f-a0b7-13e427e93a15", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/search?orgId=", "host": [ "{{baseUrl}}" ], "path": [ "search" ], "query": [ { "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T11:13:57.000Z", "updatedAt": "2026-07-28T11:13:57.000Z", "uid": "35240-8237462a-ea2b-448f-a0b7-13e427e93a15" }, { "id": "ad2d3a03-b7db-451e-9931-127c93e9c6cd", "name": "An Unexpected Error Occurred", "originalRequest": { "method": "POST", "header": [ { "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/search?orgId=", "host": [ "{{baseUrl}}" ], "path": [ "search" ], "query": [ { "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T11:13:57.000Z", "updatedAt": "2026-07-28T11:13:57.000Z", "uid": "35240-ad2d3a03-b7db-451e-9931-127c93e9c6cd" }, { "id": "3adacbb4-39e7-4ffc-a3ee-34589ccbfeb7", "name": "The service is currently unavailable to serve the requests", "originalRequest": { "method": "POST", "header": [ { "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/search?orgId=", "host": [ "{{baseUrl}}" ], "path": [ "search" ], "query": [ { "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T11:13:57.000Z", "updatedAt": "2026-07-28T11:13:57.000Z", "uid": "35240-3adacbb4-39e7-4ffc-a3ee-34589ccbfeb7" } ], "createdAt": "2026-07-28T11:13:57.000Z", "updatedAt": "2026-07-28T11:13:57.000Z", "uid": "35240-8de7655a-701c-45fc-9af7-d9cff6525f39" } ], "id": "378a1a24-a124-42bf-ad01-139eea9b016d", "createdAt": "2026-07-28T11:13:57.000Z", "updatedAt": "2026-07-28T11:13:57.000Z", "uid": "35240-378a1a24-a124-42bf-ad01-139eea9b016d" } ], "variable": [ { "key": "baseUrl", "value": "/" } ] }