List Customer Accounts - CX Cloud API

{"type":"api","title":"List Customer Accounts","meta":{"id":"/apps/pubhub/media/cx-cloud-apis/987ccbfd309f978191d5f9ff79fe93a2865583d0/cbe9e4eb-3b67-3d77-bde8-9a8275c07620","info":{"title":"CX Cloud API","version":"2.0.0","description":"APIs to access CX Cloud data","contact":{"name":"CX Cloud Community","url":"https://community.cisco.com/t5/cx-cloud/bd-p/CX-Cloud-Discussions"},"license":{"name":"Cisco API License","url":"https://developer.cisco.com/site/license/cisco-api-license/"},"termsOfService":"https://www.cisco.com/c/dam/en_us/about/doing_business/legal/seula/cx-cloud-seula.pdf"},"security":[{"Oauth2":["apis:read"]}],"tags":[{"name":"customer","description":"API operations to get customer details from entitled CX Cloud accounts"},{"name":"inventory","description":"API operations to get inventory details from entitled CX Cloud accounts"},{"name":"contract","description":"API operations to get contract details from entitled CX Cloud accounts"},{"name":"productAlert","description":"API operations to get alerts details from entitled CX Cloud accounts"}],"x-parser-conf":{"overview":{"markdownPath":"reference/overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://apix.cisco.com/cs/api/v2","description":"Cisco API Console"}],"securitySchemes":{"Oauth2":{"type":"oauth2","description":"OAuth2 authentication with authorization code flow.","flows":{"authorizationCode":{"authorizationUrl":"https://id.cisco.com/oauth2/default/v1/token","tokenUrl":"https://id.cisco.com/oauth2/default/v1/token","scopes":{"apis:read":"Grants read access"}}}}}},"spec":{"summary":"List Customer Accounts","operationId":"getCustomerDetails","description":"Returns CX Cloud accounts the user has permission to query.","tags":["customer"],"parameters":[{"name":"customerId","in":"query","description":"A CX Cloud customer identifier","schema":{"type":"string","example":"abc123def"},"$$ref":"#/components/parameters/customerId_param_optional"},{"name":"customerName","in":"query","description":"A CX Cloud customer account name","schema":{"type":"string","example":"CISCO SYSTEMS"},"$$ref":"#/components/parameters/customerName_param"},{"name":"format","in":"query","description":"Output format of the API response","schema":{"type":"string","default":"JSON","enum":["JSON","CSV","TSV"]},"$$ref":"#/components/parameters/format_param"},{"name":"fields","in":"query","description":"Restricts API response to the specific fields.","schema":{"type":"string","example":"field1,field2"},"$$ref":"#/components/parameters/fields_param"},{"name":"page","in":"query","description":"The page to return in a paginated API response.","schema":{"type":"integer","minimum":1,"default":1},"$$ref":"#/components/parameters/page_param"},{"name":"rows","in":"query","description":"The size of the page in the API response.","schema":{"type":"integer","default":20},"$$ref":"#/components/parameters/rows_param"},{"name":"sort","in":"query","description":"The sort order (ASC or DESC) for a field in the API response. Can be specified multiple times for multi-field sorting. If order is not specified for a field, it defaults to ASC. Example with multi-field sorting: sort=field&sort=field2:DESC","schema":{"type":"array","items":{"type":"string"}},"explode":true,"$$ref":"#/components/parameters/sort_param"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"Customer Details schema","type":"object","properties":{"data":{"description":"Contains array of Customer Details","type":"array","items":{"properties":{"customerId":{"description":"A CX Cloud customer identifier.","type":"string","example":"abc123def"},"city":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"country":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"customerName":{"description":"A CX Cloud customer account name","type":"string","nullable":false,"example":"CISCO SYSTEMS"},"postalcode":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"state":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"streetAddress1":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"streetAddress2":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"streetAddress3":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"streetAddress4":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"theatreCode":{"description":"CX Cloud account region","type":"string","example":"US","enum":["US","EMEA","APJC"]}}}},"pagination":{"description":"Pagination details","type":"object","properties":{"page":{"description":"Current page","type":"integer","format":"int32","example":1},"pages":{"description":"Total number of pages","type":"integer","format":"int32","example":3},"rows":{"description":"Number of records on each page","type":"integer","format":"int32","example":20},"total":{"description":"Total number of records","type":"integer","format":"int64","example":56}},"$$ref":"#/components/schemas/Pagination"}},"$$ref":"#/components/schemas/CustomerDetails"}}},"headers":{"Cache-Control":{"description":"Cache Control Header","schema":{"type":"string"},"example":"no-cache","$$ref":"#/components/headers/CacheControl"},"TrackingID":{"description":"Tracking ID","schema":{"type":"string"},"example":"1234","$$ref":"#/components/headers/TrackingID"},"Date":{"description":"Timestamp the response was processed","schema":{"type":"string","format":"E, dd MMM yyyy HH:mm:ss z"},"example":"Fri, 27 Jun 2025 09:07:36 GMT","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/CustomerDetailsResponse"},"400":{"description":"Bad Request","$$ref":"#/components/responses/BadRequestResponse"},"401":{"description":"Unauthorized","$$ref":"#/components/responses/UnauthorizedResponse"},"403":{"description":"Forbidden","$$ref":"#/components/responses/ForbiddenResponse"},"404":{"description":"Not Found","$$ref":"#/components/responses/NotFoundResponse"},"500":{"description":"Internal Server Error","$$ref":"#/components/responses/InternalServerErrorResponse"}},"security":[{"Oauth2":["apis:read"]}],"__originalOperationId":"getCustomerDetails","method":"get","path":"/customer-info/customer-details"}}