{"info":{"_postman_id":"f6668c5a-9bc7-44ad-a3c2-c4c78b736367","name":"API Cxpress","description":"

Welcome to the Cxpress Integration API Documentation

This document presents the technical specifications for the available requests to interact with the API, allowing for queries and modifications from external applications. It also includes instructions for generating the authentication token, which is essential to ensure secure access to the endpoints. This guide aims to provide all the necessary information for efficient, structured, and reliable API consumption, enabling safe and standardised integration with external systems.

Structure

The documentation is organised by versions, prioritising the most recent version of the API.
\n
If a specific endpoint is not documented in the latest version, the endpoint available in the most recent version in which it is documented should be used.
\n
The Cxpress API has a limit of 300 requests per minute per IP address. If this limit is exceeded within a 60-second period, a 10-minute security block will be automatically applied to the IP address responsible for the requests.
\n

Creating an Integration Entity

To create a new integration entity, a user with the COMPANY OWNER profile must follow the path below within the platform:

Sidebar Menu → Configurations → Company → API

\n\n

On the API screen, click the button located in the upper corner of the interface:

\n\n

When this button is clicked, a modal will be displayed where the following information must be provided:

Token name: Identification name for the integration entity.
\n
Permissions: Selection of the endpoints the token will be allowed to access.
\n

\n\n

Once the integration entity is created, the API Token and Refresh Token will be generated and made available to the user. These tokens allow authentication of requests and enable modifications within the Cxpress platform via integration with external systems.

⚠️ Important: Tokens are displayed only once after creation. Ensure they are stored securely.

\n\n

Token Validity and Management

The API Token is valid for 1 hour. After this period, it is automatically invalidated.
\n
The Refresh Token is valid for 168 hours (7 days). After expiry, it is no longer possible to generate new access tokens from it.
\n

The integration token will appear in the list within the interface, but it cannot be edited. If access permissions need to be changed, the user must create a new token and define the required permissions during creation.

\n\n

The Endpoints 1.0 section of this document details the responses of all endpoints accessible via an integration token, along with instructions on how to use them.

Webhook Configuration

The webhook functionality allows external systems to be automatically notified whenever specific events occur within the Cxpress platform.

On the API screen, click the button located above the token listing:

\n\n

Configuration Fields

When this button is clicked, a modal will appear where the following information must be filled in:

Endpoint: The destination URL to which event notifications will be sent. This is the address configured to receive HTTP requests generated by the webhook mechanism.
\n
Events: Allows the selection of events that should trigger notifications to the configured endpoint. The following types of events can be enabled individually:
\n
- Creation (create) – Triggered when one of the available entities is created in Cxpress.
  \n
- Update (update) – Triggered when one of the available entities is modified in Cxpress.
  \n
\n

\n\n

Available Entities

Webhook notifications cover events related to the following entity types:

Consumer
\n
Ticket
\n
Task
\n
Department
\n
Ticket Tags
\n
Consumer Tags
\n
Custom Fields
\n

How It Works

When an event type (Creation or Update) is enabled, the system will automatically send an HTTP POST notification to the configured endpoint whenever the corresponding action occurs for a supported entity.

The request payload will include the updated or newly created data of the entity, allowing the external system to respond to changes in real time.

Example Use Case

When the create event is enabled, the configured endpoint will be triggered whenever one of the available entities is created in the system. The request sent to the endpoint will contain, in its body (payload), the data of the newly created entity.

For example, in the case of a creation event for the Department entity, the request body will be structured as follows:

{\n  \"entity\": \"sector\",\n  \"type\": \"create\",\n  \"data\": {\n    \"id\": \"4f36f4aa-78do-462d-bcoa-a74beb69452b\",\n    \"company id\": \"G6cce6aBge-Oaeo-4e4c-Seac-e7d5ecaafaa7\",\n    \"name\": \"Setor teste\",\n    \"updated at\": \"2025-05-08T16:02:37.5692\",\n    \"deleted at\": null,\n    \"active\": true,\n    \"created at\": \"2025-05-08T16:02:37.5692\",\n    \"employees user ids\": [\n      \"981c9949-2327-4fO0e-98d2-2a61f7ecbeaf\",\n      \"feda355a-a75b-4a8a-b599-e2do2c23f983\"\n    ],  \n    \"key words\": [\n      \"esquerda\"\n    ]\n  }\n}\n\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Creating an Integration Entity","slug":"creating-an-integration-entity"},{"content":"Webhook Configuration","slug":"webhook-configuration"}],"owner":"45421173","collectionId":"f6668c5a-9bc7-44ad-a3c2-c4c78b736367","publishedId":"2sB2x6msBP","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"232960"},"publishDate":"2025-06-13T17:50:42.000Z"},"item":[{"name":"Endpoints 1.0","item":[{"name":"Update Token","id":"f70db0e0-085c-40d6-a5ae-cc6cbe6ec3e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"refresh_token\": \"{Refresh_Token}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cxpress.io/external/update/token","description":"

Updates the API authentication token after it has expired.

The request must include a JSON-formatted body containing a valid Refresh Token.

The response will return:

a new valid API Token
\n
a new valid Refresh Token
\n

This endpoint does not require permission to be enabled in the interface, unlike the other endpoints in this document.

\n","urlObject":{"protocol":"https","path":["external","update","token"],"host":["api","cxpress","io"],"query":[],"variable":[]}},"response":[{"id":"d5837e35-9ea1-4ce8-bf71-5e4fe6c7f75c","name":"Update Token","originalRequest":{"method":"PUT","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"refresh_token\": \"Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cxpress.io/external/update/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n\t\"message\": \"Request successfully fulfilled.\",\r\n\t\"code_cxpress\": 6700,\r\n\t\"token\": \"Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1\",\r\n\t\"refresToken\": \"Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1\"\r\n}"}],"_postman_id":"f70db0e0-085c-40d6-a5ae-cc6cbe6ec3e5"},{"name":"List Consumers","id":"18418b46-663c-4aa1-88d9-61a844375896","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/consumer","description":"

Returns information on all consumers linked to the company.

Supports query parameters.

\n","urlObject":{"protocol":"https","path":["external","consumer"],"host":["api","cxpress","io"],"query":[{"disabled":true,"description":{"content":"

Defines the maximum number of consumers to be returned per page.

\n","type":"text/plain"},"key":"limit","value":"integer > 0, optional"},{"disabled":true,"description":{"content":"

Specifies the page number to be returned in the paginated list of consumers.

\n","type":"text/plain"},"key":"page","value":"integer > 0, optional"},{"disabled":true,"description":{"content":"

Allows filtering of consumers based on a search string. The search is applied to the following fields: 'name', 'email', 'document_number', 'phone', 'whatsapp', 'instagram', 'twitter', 'facebook', 'youtube', and 'address'.

\n","type":"text/plain"},"key":"search","value":"string, optional"},{"disabled":true,"description":{"content":"

Defines the field by which results should be sorted. Currently supported value: 'name'.

\n","type":"text/plain"},"key":"sort_by","value":"string, optional"},{"disabled":true,"description":{"content":"

Indicates the direction of the sorting. Allowed values: 'asc' (ascending order) or 'desc' (descending order).

\n","type":"text/plain"},"key":"order_by","value":"string, optional"},{"disabled":true,"description":{"content":"

Filters consumers based on an array of consumer tag IDs. Values should be comma-separated. Example: tag_id1,tag_id2,tag_id3.

\n","type":"text/plain"},"key":"tags","value":"array[string], optional"},{"disabled":true,"description":{"content":"

Filters consumers based on an array of operator IDs. Values should be comma-separated. Example: employee_id1,employee_id2,employee_id3.

\n","type":"text/plain"},"key":"employee","value":"array[string], optional"},{"disabled":true,"description":{"content":"

Determines whether the filter should consider all consumer tags registered in the company. Accepted values: 'true' or 'false'.

\n","type":"text/plain"},"key":"allTags","value":"boolean, optional"},{"disabled":true,"description":{"content":"

Filters consumers who were automatically created when contacting the company via the Telephony channel. Accepted values: 'true' or 'false'.

\n","type":"text/plain"},"key":"is_for_dialer","value":"boolean, optional"}],"variable":[]}},"response":[{"id":"c5f8deaa-6edb-4694-819f-577ce8ed3b6d","name":"List Consumers","originalRequest":{"method":"GET","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/consumer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n\t\"message\": \"successfully.\",\r\n\t\"consumers\": [\r\n\t\t{\r\n\t\t\t\"name\": \"01\",\r\n\t\t\t\"lastname\": null,\r\n\t\t\t\"user_id\": \"6d2904bd-cadc-40a3-9ac8-b7b13c0ae1a9\",\r\n\t\t\t\"email\": null,\r\n\t\t\t\"document_number\": null,\r\n\t\t\t\"phone\": \"558765876699\",\r\n\t\t\t\"address\": null,\r\n\t\t\t\"whatsapp\": null,\r\n\t\t\t\"employee_user_id\": null,\r\n\t\t\t\"direct_attendance_n2\": false,\r\n\t\t\t\"created_by_employee\": \"false\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"name\": \"02 espanha\",\r\n\t\t\t\"lastname\": null,\r\n\t\t\t\"user_id\": \"2bcf3319-09a3-4fd2-82f4-e3c6fb88beda\",\r\n\t\t\t\"email\": null,\r\n\t\t\t\"document_number\": null,\r\n\t\t\t\"phone\": \"34612345678\",\r\n\t\t\t\"address\": null,\r\n\t\t\t\"whatsapp\": null,\r\n\t\t\t\"employee_user_id\": null,\r\n\t\t\t\"direct_attendance_n2\": false,\r\n\t\t\t\"created_by_employee\": \"false\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"name\": \"11\",\r\n\t\t\t\"lastname\": null,\r\n\t\t\t\"user_id\": \"a1874711-399a-45d9-98bf-63d39ddad466\",\r\n\t\t\t\"email\": \"1@email.com\",\r\n\t\t\t\"document_number\": null,\r\n\t\t\t\"phone\": null,\r\n\t\t\t\"address\": null,\r\n\t\t\t\"whatsapp\": null,\r\n\t\t\t\"employee_user_id\": null,\r\n\t\t\t\"direct_attendance_n2\": false,\r\n\t\t\t\"created_by_employee\": \"true\"\r\n\t\t}\r\n ],\r\n\t\"code_cxpress\": 1400,\r\n\t\"pagination\": {\r\n\t\t\"total\": 3,\r\n\t\t\"lastPage\": 1,\r\n\t\t\"prevPage\": null,\r\n\t\t\"nextPage\": null,\r\n\t\t\"perPage\": 100,\r\n\t\t\"currentPage\": 1,\r\n\t\t\"from\": 0,\r\n\t\t\"to\": 100\r\n\t}\r\n}"}],"_postman_id":"18418b46-663c-4aa1-88d9-61a844375896"},{"name":"Show consumer","id":"624bff85-33c3-4baa-97c7-d5be62ecd79b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/consumer/{user_id}","description":"

Displays the information of a specific consumer.

The consumer’s user_id must be provided in the endpoint, similar to the example shown in the cURL under \"Example\".

\n","urlObject":{"protocol":"https","path":["external","consumer","{user_id}"],"host":["api","cxpress","io"],"query":[],"variable":[]}},"response":[{"id":"56d7e2fa-0059-4f94-97f7-144fbafffd7c","name":"Show consumer","originalRequest":{"method":"GET","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/consumer/191efbd3-1cab-4f7e-8ec1-7ae173e57dc3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n\t\"message\": \"successfully.\",\r\n\t\"consumers\": [\r\n\t\t{\r\n\t\t\t\"id\": \"6cf3a2fc-bf53-4a53-86bd-71e05cd4f41a\",\r\n\t\t\t\"user_id\": \"191efbd3-1cab-4f7e-8ec1-7ae173e57dc3\",\r\n\t\t\t\"name\": \"Marcos 2\",\r\n\t\t\t\"lastname\": null,\r\n\t\t\t\"document_number\": null,\r\n\t\t\t\"email\": \"email@gmail.com\",\r\n\t\t\t\"phone\": null,\r\n\t\t\t\"instagram\": null,\r\n\t\t\t\"twitter\": null,\r\n\t\t\t\"facebook\": null,\r\n\t\t\t\"youtube\": null,\r\n\t\t\t\"whatsapp\": null,\r\n\t\t\t\"address\": null,\r\n\t\t\t\"observations\": null,\r\n\t\t\t\"webchat\": null,\r\n\t\t\t\"employee_user_id\": null,\r\n\t\t\t\"instagram_user\": null,\r\n\t\t\t\"facebook_user\": null,\r\n\t\t\t\"line_type_whatsapp\": null,\r\n\t\t\t\"direct_attendance_n2\": false,\r\n\t\t\t\"created_by_employee\": \"true\",\r\n\t\t\t\"tags\": [\r\n\t\t\t\tnull\r\n\t\t\t],\r\n\t\t\t\"custom_fields\": []\r\n\t\t}\r\n\t],\r\n\t\"code_cxpress\": 1400\r\n}"}],"_postman_id":"624bff85-33c3-4baa-97c7-d5be62ecd79b"},{"name":"Create Consumer","id":"d05f2d01-ae32-4a85-8dc1-01fcbc5d5c3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"string\",\r\n \"lastname\": \"string\",\r\n \"document_number\": \"string\",\r\n \"email_addresses\": [\r\n \"email@email.com\"\r\n ],\r\n \"phone\": \"Phone number in the format: Country Code + Area Code + Number\",\r\n \"twitter\": \"string\",\r\n \"observations\": \"string\",\r\n \"youtube\": \"string\",\r\n \"address\": \"string\",\r\n \"whatsapp_numbers\": [\r\n \"Phone number in the format: Country Code + Area Code + Number\"\r\n ],\r\n \"custom_fields\": [\r\n {\r\n \"custom_field_id\": \"id\",\r\n \"value\": [\r\n \"Text only | Digits only | All character types\"\r\n ]\r\n }\r\n ],\r\n \"employee_user_id\": \"id\",\r\n \"tags\": [\r\n \"id\"\r\n ],\r\n \"direct_attendance_n2\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cxpress.io/external/consumer","description":"

Creates a new consumer linked to the company.

The request must include a JSON-formatted body with the following required field:

name (string) – Consumer’s first name
\n
- Must be a string.
\n

Optional fields:

lastname (string) – Consumer’s surname
\n
- Must be a string.
\n
document_number (string) – Consumer’s document number
\n
- Must be a string.
\n
email_addresses [] (array[string]) – Consumer email address(es)
\n
- Must be filled in with one or more valid email addresses.
\n
phone (string) – Consumer’s phone number
\n
- Must be a valid phone number in the format: CountryCode + AreaCode + Number
  \n
- Example: 551121222324
  \n
\n
twitter (string) – Consumer’s Twitter handle
\n
- Must be a string.
\n
observations (string) – Observations about the consumer
\n
- Must be a string.
\n
youtube (string) – Consumer’s YouTube username
\n
- Must be a string.
\n
address (string) – Consumer’s address
\n
- Must be a string.
\n
whatsapp_numbers [] _(array_[string]) – Consumer’s WhatsApp number
\n
- Must be filled in with one or more valid phone numbers, using the format: Country code + Area code + number.
  \n
  - Example: 5511999887766
  \n
\n
custom_fields (array[object]) – Custom fields associated with the consumerEach object must contain:
\n
- id (string) – Custom field ID
  \n
- value (string) – Value according to the field type
  \n
- ⚠️ Only consumer custom fields are accepted. Using ticket custom fields will cause an error. Field value rules:
  \n
  - Text: Letters only (a–z, A–Z), including accented characters (e.g. é, ã, ç). No spaces.
    \n
  - Numeric: Digits only (0–9). No spaces.
    \n
  - General: Accepts any character, including spaces and special symbols.
    \n
  \n
\n
employee_user_id (string) – ID of the operator responsible for the consumer
\n
- Must be the user_id of an existing operator.
\n
tags (array[string]) – List of tag IDs associated with the consumer
\n
- Must be an array of strings. Each string represents a consumer tag id.
  \n
- Tags must have the active field set to true.
  \n
\n
direct_attendance_n2 (boolean) – Indicates whether the consumer should be directly routed to a human agent (Level 2), bypassing the chatbot (Level 1)
\n
- false: default behaviour via chatbot
  \n
- true: ticket is created directly under human support
  \n
\n

Uniqueness rules

The consumer creation will be rejected if any value in the following fields already exists for another consumer, in order to prevent data duplication:

document_number
\n
email_addresses
\n
phone
\n
twitter
\n
youtube
\n
whatsapp_numbers
\n

\n","urlObject":{"protocol":"https","path":["external","consumer"],"host":["api","cxpress","io"],"query":[],"variable":[]}},"response":[{"id":"e77852c4-bc3e-4472-94ca-fd449f552231","name":"Create Consumer","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"abcde\",\r\n \"lastname\": \"fghi\",\r\n \"whatsapp_numbers\": [\r\n \"5581999887766\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cxpress.io/external/consumer"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n\t\"message\": \"successfully.\",\r\n\t\"consumers\": [\r\n\t\t{\r\n\t\t\t\"id\": \"77110679-5c1c-4fae-b0ae-ddff5d3f1f94\",\r\n\t\t\t\"user_id\": \"5ccb32d0-63be-4f51-8bdc-145af4f7977a\",\r\n\t\t\t\"name\": \"abcde\",\r\n\t\t\t\"lastname\": \"fghi\",\r\n\t\t\t\"document_number\": null,\r\n\t\t\t\"email\": null,\r\n\t\t\t\"phone\": null,\r\n\t\t\t\"instagram\": null,\r\n\t\t\t\"twitter\": null,\r\n\t\t\t\"facebook\": null,\r\n\t\t\t\"youtube\": null,\r\n\t\t\t\"whatsapp\": null,\r\n\t\t\t\"address\": null,\r\n\t\t\t\"observations\": null,\r\n\t\t\t\"webchat\": null,\r\n\t\t\t\"employee_user_id\": null,\r\n\t\t\t\"instagram_user\": null,\r\n\t\t\t\"facebook_user\": null,\r\n\t\t\t\"line_type_whatsapp\": null,\r\n\t\t\t\"direct_attendance_n2\": false\r\n\t\t}\r\n\t],\r\n\t\"code_cxpress\": 1400\r\n}"}],"_postman_id":"d05f2d01-ae32-4a85-8dc1-01fcbc5d5c3c"},{"name":"Edit Consumer","id":"a7013a2f-05ef-4c91-84ca-e6ebef917e05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"user_id\",\r\n \"name\": \"string\",\r\n \"lastname\": \"string\",\r\n \"document_number\": \"string\",\r\n \"email_addresses\": [\r\n \"email@email.com\"\r\n ],\r\n \"phone\": \"Phone number in the format: Country Code + Area Code + Number\",\r\n \"twitter\": \"string\",\r\n \"observations\": \"string\",\r\n \"youtube\": \"string\",\r\n \"address\": \"string\",\r\n \"whatsapp_numbers\": [\r\n \"Phone number in the format: Country Code + Area Code + Number\"\r\n ],\r\n \"custom_fields\": [\r\n {\r\n \"custom_field_id\": \"id\",\r\n \"value\": [\r\n \"Text only | Digits only | All character types\"\r\n ]\r\n }\r\n ],\r\n \"employee_user_id\": \"id\",\r\n \"tags\": [\r\n \"id\"\r\n ],\r\n \"direct_attendance_n2\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cxpress.io/external/consumer","description":"

Updates the information of an existing consumer linked to the company.

The request must include a JSON-formatted body with the following required field:

id (string) – Unique identifier of the consumer to be updated
\n
- Must be filled with the user_id of the consumer.
\n

Edition rules:

1 - In addition to id, at least one of the following fields must be included for the update to proceed:

Minimum required fields:

name
\n
lastname
\n
phone
\n
email_addresses
\n
document_number
\n
twitter
\n
observations
\n

2 - The following fields may not be updated while the customer has ongoing tickets, whether handled by a human agent or by a chatbot.

email_addresses
\n
whatsapp_numbers
\n

3 - Other fields available for update follow the same validation rules as described in the Create Consumer endpoint.

4 - Only the fields that will be updated must be sent in the body. The other fields that are already filled in and are not included in the body will remain with the same value after the edit request is executed.

\n","urlObject":{"protocol":"https","path":["external","consumer"],"host":["api","cxpress","io"],"query":[],"variable":[]}},"response":[{"id":"64f7426f-aedd-49e6-8a35-885257ec2c00","name":"Edit Consumer","originalRequest":{"method":"PUT","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"id\": \"26f0945e-7d18-4782-8249-f3ff46e29b77\",\r\n\t\"name\": \"abcdfgh\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cxpress.io/external/consumer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n\t\"message\": \"Consumer successfully updated.\",\n\t\"consumer\": {\n\t\t\"id\": \"1c1f8aaf-88bf-4e1c-8248-1984116b7e37\",\n\t\t\"user_id\": \"26f0945e-7d18-4782-8249-f3ff46e29b77\",\n\t\t\"lastname\": null,\n\t\t\"document_number\": null,\n\t\t\"email\": null,\n\t\t\"phone\": null,\n\t\t\"instagram\": null,\n\t\t\"twitter\": null,\n\t\t\"facebook\": null,\n\t\t\"youtube\": null,\n\t\t\"whatsapp\": null,\n\t\t\"address\": null,\n\t\t\"observations\": null,\n\t\t\"webchat\": null,\n\t\t\"instagram_user\": null,\n\t\t\"facebook_user\": null,\n\t\t\"line_type_whatsapp\": null,\n\t\t\"direct_attendance_n2\": false,\n \"whatsapp_numbers\": [\n\t\t\t{\n\t\t\t\t\"number\": \"5511999887766\",\n\t\t\t\t\"line_type\": \"mobile\"\n\t\t\t}\n\t\t],\n\t\t\"email_addresses\": null,\n\t\t\"custom_fields\": []\n\t},\n\t\"code_cxpress\": 1400\n}"}],"_postman_id":"a7013a2f-05ef-4c91-84ca-e6ebef917e05"},{"name":"Delete Consumer","id":"28735fd1-1f9d-4394-8e1f-9dd9b65333e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/consumer/{user_id}","description":"

Deletes a consumer from the company.

The ID of the consumer to be deleted must be specified in the endpoint URL, as shown in the cURL Example.

If the consumer has tickets with statuses such as New, Open, Pending, or On Hold at the time of deletion, all these ongoing tickets will be automatically closed. They will no longer appear in the ticket list.

Returns information on all consumer tags linked to the company.

Supports query parameters.

\n","urlObject":{"protocol":"https","path":["external","consumer-tag"],"host":["api","cxpress","io"],"query":[{"disabled":true,"description":{"content":"

Specifies the page number to be returned in the paginated list of consumer tags.

\n","type":"text/plain"},"key":"page","value":"integer > 0, optional"},{"disabled":true,"description":{"content":"

Defines the maximum number of consumer tags to be returned per page.

\n","type":"text/plain"},"key":"limit","value":"integer > 0, optional"},{"disabled":true,"description":{"content":"

Filters the list to return either active or inactive consumer tags. This parameter must be set to 'true' (active tags) or 'false' (inactive tags).

\n","type":"text/plain"},"key":"active","value":"boolean, optional"},{"disabled":true,"description":{"content":"

Allows filtering of consumer tags based on a search string. The search is applied to the following fields: 'id' and 'name'.

\n","type":"text/plain"},"key":"search","value":"string, optional"},{"disabled":true,"description":{"content":"

Defines the field by which results should be sorted. Currently supported values: 'name', 'reference_id', 'active', 'created_at'.

\n","type":"text/plain"},"key":"sort_by","value":"string, optional"},{"disabled":true,"description":{"content":"

Indicates the direction of the sorting. Allowed values: 'asc' (ascending order) or 'desc' (descending order).

\n","type":"text/plain"},"key":"order_by","value":"string, optional"}],"variable":[]}},"response":[{"id":"d8893fc2-7497-45fb-ae16-5a2d2c9ad4d9","name":"List Consumer Tags","originalRequest":{"method":"GET","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/consumer-tag"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n\t\"message\": \"Request successfully fulfilled.\",\r\n\t\"tags\": [\r\n\t\t{\r\n\t\t\t\"id\": \"74cccdc3-8bb8-4f51-9108-92708dcdffb0\",\r\n\t\t\t\"reference_id\": 38,\r\n\t\t\t\"name\": \"atag\",\r\n\t\t\t\"active\": false,\r\n\t\t\t\"created_at\": \"2024-10-02T12:11:04.904Z\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"aedd89db-f829-4879-883b-a5986c4935b8\",\r\n\t\t\t\"reference_id\": 54,\r\n\t\t\t\"name\": \"a_teste\",\r\n\t\t\t\"active\": true,\r\n\t\t\t\"created_at\": \"2024-12-30T18:04:26.897Z\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"2baf9081-a458-4f84-9649-ee25d1c4aea0\",\r\n\t\t\t\"reference_id\": 1,\r\n\t\t\t\"name\": \"con12\",\r\n\t\t\t\"active\": true,\r\n\t\t\t\"created_at\": \"2024-04-08T13:50:30.572Z\"\r\n\t\t}\r\n\t],\r\n\t\"code_cxpress\": 5500,\r\n\t\"pagination\": {\r\n\t\t\"total\": 3,\r\n\t\t\"lastPage\": 1,\r\n\t\t\"prevPage\": null,\r\n\t\t\"nextPage\": null,\r\n\t\t\"perPage\": 100,\r\n\t\t\"currentPage\": 1,\r\n\t\t\"from\": 0,\r\n\t\t\"to\": 3\r\n\t}\r\n}"}],"_postman_id":"dc96c3a4-08e8-4173-a829-1f1237966b53"},{"name":"Create Consumer Tag","id":"4b1b8025-662e-4701-b145-13bd8b869e0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"active\": true,\r\n \"name\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cxpress.io/external/consumer-tag","description":"

Creates a consumer tag linked to the company.

This consumer tag can be associated with a consumer via the Create Consumer and Edit Consumer endpoints, provided that the active field is set to true.

The request body must be in JSON format and include the following required fields:

active (boolean) – Field indicating whether the consumer tag is active
\n
- Must be true or false.
\n
name (string) – Name of the consumer tag
\n
- Must be a string.
  \n
- The name must be unique – it cannot match the name of an existing consumer tag.
  \n
\n

\n","urlObject":{"protocol":"https","path":["external","consumer-tag"],"host":["api","cxpress","io"],"query":[],"variable":[]}},"response":[{"id":"adc3b11f-78bf-48b7-a4f8-200b9ab07ad8","name":"Create Consumer Tag","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"active\": true,\r\n \"name\": \"teste2905\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cxpress.io/external/consumer-tag"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Request successfully fulfilled.\",\n \"code_cxpress\": 5500\n}"}],"_postman_id":"4b1b8025-662e-4701-b145-13bd8b869e0e"},{"name":"Edit Consumer Tag","id":"469e1be0-bbbd-4602-a9ef-6693da44929c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"active\": true,\r\n \"name\": \"string\",\r\n \"id\": \"id\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cxpress.io/external/consumer-tag","description":"

Updates the information of a consumer tag linked to the company.

The request must include a JSON-formatted body with the following field:

id (string) – Unique identifier of the consumer tag to be updated
\n
- Must be a valid tag ID.
\n

All other fields follow the same structure and validation rules as those described in the Create Consumer Tag endpoint.

\n","urlObject":{"protocol":"https","path":["external","consumer-tag"],"host":["api","cxpress","io"],"query":[],"variable":[]}},"response":[{"id":"a6a483cf-31d2-42d8-ac9e-a2a001fdbf9e","name":"Edit Consumer Tag","originalRequest":{"method":"PUT","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"active\": true,\r\n \"name\": \"teste2905\",\r\n\t\"id\": \"48a8ae11-0d70-408f-8a5b-973e58a3f85d\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cxpress.io/external/consumer-tag"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Request successfully fulfilled.\",\n \"code_cxpress\": 5500,\n \"tag\": {\n \"id\": \"48a8ae11-0d70-408f-8a5b-973e58a3f85d\",\n \"reference_id\": 55,\n \"name\": \"teste2905\",\n \"active\": true,\n \"created_at\": \"2025-05-29T20:25:03.470Z\"\n }\n}"}],"_postman_id":"469e1be0-bbbd-4602-a9ef-6693da44929c"},{"name":"List Tickets","id":"e0ed2f2f-b8a0-44eb-a4a6-bca67881bc62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/ticket","description":"

Returns information on all support tickets linked to the company.

Query parameters are available.

\n","urlObject":{"protocol":"https","path":["external","ticket"],"host":["api","cxpress","io"],"query":[{"disabled":true,"description":{"content":"

Defines the maximum number of tickets to be returned per page.

\n","type":"text/plain"},"key":"limit","value":"integer > 0, optional"},{"disabled":true,"description":{"content":"

Specifies the page number to be returned in the paginated list of tickets.

\n","type":"text/plain"},"key":"page","value":"integer > 0, optional"},{"disabled":true,"description":{"content":"

Filters the list to return tickets with a specific status. This parameter should be filled with a 'status_id' value. With the ticket status value being:\nNew - daddbd66-1dd2-4008-94c9-7fcb9b1a5800\nOpen- b58c1105-0ffe-4d07-a7d6-751389fc3008\nPending - 0ec35dbb-398e-4c2f-996c-933af162c950\nOn Hold - 3dd9b9ac-7399-4ce8-b22c-a513eb473803

\n","type":"text/plain"},"key":"status","value":"string, optional"},{"disabled":true,"description":{"content":"

Filters the list to return tickets that belong to a specific channel. This parameter should be filled with a 'channel_id' value.

\n","type":"text/plain"},"key":"channel","value":"string, optional"},{"disabled":true,"description":{"content":"

Filters the list to return tickets assigned to a specific operator. This parameter should be filled with a 'user_id' value.

\n","type":"text/plain"},"key":"employee","value":"string, optional"},{"disabled":true,"description":{"content":"

Filters the list to return tickets that involved chatbot interaction. This parameter must be 'true' or 'false'.

\n","type":"text/plain"},"key":"bot","value":"boolean, optional"},{"disabled":true,"description":{"content":"

Filters tickets based on an array of automation keys. Values should be comma-separated. Example: entity_key1,entity_key2,entity_key3.

\n","type":"text/plain"},"key":"automation","value":"array[string], optional"},{"disabled":true,"description":{"content":"

Filters tickets by date range. Must be used in conjunction with 'end_date'.

\n","type":"text/plain"},"key":"start_date","value":"data no formato ISO 8601 ex.: YYYY-MM-DD, optional"},{"disabled":true,"description":{"content":"

Filters tickets by date range. Must be used in conjunction with 'start_date'.

\n","type":"text/plain"},"key":"end_date","value":"data no formato ISO 8601 ex.: YYYY-MM-DD, optional"},{"disabled":true,"description":{"content":"

Allows filtering of tickets based on a search string. The search is applied to the ticket field: 'ticket_reference_id' and the consumer fields: 'name', 'lastname', 'email', 'whatsapp', and 'phone'.

\n","type":"text/plain"},"key":"search","value":"string, optional"},{"disabled":true,"description":{"content":"

Filters the list to return tickets that belong to a specific sector. This parameter should be filled with a 'sector_id' value.

\n","type":"text/plain"},"key":"sector","value":"string, optional"},{"disabled":true,"description":{"content":"

Indicates the direction of the sorting. Allowed values: 'asc' (ascending order) or 'desc' (descending order).

\n","type":"text/plain"},"key":"order_by","value":"string, optional"},{"disabled":true,"description":{"content":"

Defines the field by which results should be sorted. Currently supported values: 'home_ticket_update_at' and 'updated_level2_at'.

\n","type":"text/plain"},"key":"sort_by","value":"string, optional"},{"disabled":true,"description":{"content":"

Filters tickets based on an array of ticket tag IDs. Values should be comma-separated. Example: tag_id1,tag_id2,tag_id3.

\n","type":"text/plain"},"key":"tags","value":"array[string], optional"},{"disabled":true,"description":{"content":"

Filters the list to return tickets that have or have not been read. This parameter must be 'true' (read) or 'false' (unread).

\n","type":"text/plain"},"key":"was_read","value":"boolean, optional"},{"disabled":true,"description":{"content":"

Filters the list to return tickets that either belong to a sector or not. This parameter must be 'true'.

\n","type":"text/plain"},"key":"is_all_sectors","value":"boolean, optional"}],"variable":[]}},"response":[{"id":"7b58a5a4-7f6c-4041-af1e-ac6f86100128","name":"List Tickets","originalRequest":{"method":"GET","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/ticket"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Request successfully fulfilled.\",\n \"code_cxpress\": 700,\n \"tickets\": [\n {\n \"id\": \"2f61bd86-ddd3-46c6-ab9e-03746502303f\",\n \"status_id\": \"daddbd66-1dd2-4008-94c9-7fcb9b1a5800\",\n \"updated_at\": \"2025-05-29T15:10:49.614Z\",\n \"updated_level2_at\": \"2025-05-29T13:41:42.781Z\",\n \"channel_id\": \"3f3fa530-fd3e-4018-ab98-4d9c3cd5406a\",\n \"deleted_at\": null,\n \"ticket_reference_id\": \"30595\",\n \"subject\": \"test\",\n \"who_is_viewing\": null,\n \"consumer_last_message\": \"2025-05-29T13:41:43.156Z\",\n \"processing\": false,\n \"who_is_viewing_user_id\": null,\n \"home_ticket_update_at\": \"2025-05-29T13:41:43.156Z\",\n \"requester_user\": {\n \"name\": \"Alana\",\n \"lastname\": null\n },\n \"assigned_employee\": {\n \"name\": null,\n \"lastname\": null\n },\n \"sector\": {\n \"id\": \"e937f3c3-2ad7-4e53-b02d-ae963c9a723f\",\n \"name\": \"AAA Setor API teste\"\n },\n \"bold\": false,\n \"last_message\": \"eteste\\n\\n-- \\n[image: Elife]\\n\\n[image: We deliver insights] \\n *Alana Tenório*\\n_cel: *+55 87 99950-2991*\\n\\nwww.elife.com.br\\n\",\n \"tags\": null,\n \"custom_fiejds\": null\n },\n {\n \"id\": \"6ff4ec2f-ebc9-447c-91ea-0758f0405fd9\",\n \"status_id\": \"b58c1105-0ffe-4d07-a7d6-751389fc3008\",\n \"updated_at\": \"2025-05-29T14:09:35.161Z\",\n \"updated_level2_at\": \"2025-05-28T16:08:22.594Z\",\n \"channel_id\": \"3f3fa530-fd3e-4018-ab98-4d9c3cd5406a\",\n \"deleted_at\": null,\n \"ticket_reference_id\": \"30573\",\n \"subject\": \"texte\",\n \"who_is_viewing\": null,\n \"consumer_last_message\": \"2025-05-28T16:11:41.557Z\",\n \"processing\": false,\n \"who_is_viewing_user_id\": null,\n \"home_ticket_update_at\": \"2025-05-28T16:11:41.557Z\",\n \"requester_user\": {\n \"name\": \"Alana\",\n \"lastname\": null\n },\n \"assigned_employee\": {\n \"name\": \"Alana\",\n \"lastname\": null\n },\n \"sector\": {\n \"id\": \"e937f3c3-2ad7-4e53-b02d-ae963c9a723f\",\n \"name\": \"AAA Setor API externa\"\n },\n \"bold\": false,\n \"last_message\": \"Recebido.\\n\\nEm qua., 28 de mai. de 2025 às 13:11,\\n\\nescreveu:\\n\\n>\\n> AAAAAAAA\\n>\\n> *Alana | Teste Ari 03*\\n> ------------------------------\\n> ------------------------------\\n>\\n\",\n \"tags\": null,\n \"custom_fiejds\": null\n },\n {\n \"id\": \"8e10b67b-388d-42f1-8b64-c5db46acb430\",\n \"status_id\": \"daddbd66-1dd2-4008-94c9-7fcb9b1a5800\",\n \"updated_at\": \"2025-05-29T12:29:52.759Z\",\n \"updated_level2_at\": \"2025-05-28T12:18:35.195Z\",\n \"channel_id\": \"3f3fa530-fd3e-4018-ab98-4d9c3cd5406a\",\n \"deleted_at\": null,\n \"ticket_reference_id\": \"30572\",\n \"subject\": \"TesteDeEnvio\",\n \"who_is_viewing\": null,\n \"consumer_last_message\": \"2025-05-28T12:18:35.669Z\",\n \"processing\": false,\n \"who_is_viewing_user_id\": null,\n \"home_ticket_update_at\": \"2025-05-28T12:18:35.669Z\",\n \"requester_user\": {\n \"name\": \"email3@gmail.com\",\n \"lastname\": null\n },\n \"assigned_employee\": {\n \"name\": null,\n \"lastname\": null\n },\n \"sector\": {\n \"id\": \"e937f3c3-2ad7-4e53-b02d-ae963c9a723f\",\n \"name\": \"AAA Setor API externa\"\n },\n \"bold\": false,\n \"last_message\": \"AAAAA\\n\",\n \"tags\": null,\n \"custom_fiejds\": null\n },\n {\n \"id\": \"ade030ec-5044-4182-a374-69ddd99e9b11\",\n \"status_id\": \"0ec35dbb-398e-4c2f-996c-933af162c950\",\n \"updated_at\": \"2025-05-29T12:30:05.762Z\",\n \"updated_level2_at\": \"2025-05-28T11:42:19.775Z\",\n \"channel_id\": \"3f3fa530-fd3e-4018-ab98-4d9c3cd5406a\",\n \"deleted_at\": null,\n \"ticket_reference_id\": \"30570\",\n \"subject\": \"ticket\",\n \"who_is_viewing\": null,\n \"consumer_last_message\": null,\n \"processing\": false,\n \"who_is_viewing_user_id\": null,\n \"home_ticket_update_at\": \"2025-05-28T11:43:05.102Z\",\n \"requester_user\": {\n \"name\": \"email2@gmail.com\",\n \"lastname\": null\n },\n \"assigned_employee\": {\n \"name\": \"Alana\",\n \"lastname\": null\n },\n \"sector\": {\n \"id\": null,\n \"name\": null\n },\n \"bold\": false,\n \"last_message\": \"oi\",\n \"tags\": null,\n \"custom_fiejds\": null\n },\n {\n \"id\": \"13a3ff38-125d-4a4a-b455-d1841287a96f\",\n \"status_id\": \"0ec35dbb-398e-4c2f-996c-933af162c950\",\n \"updated_at\": \"2025-05-29T12:30:47.758Z\",\n \"updated_level2_at\": \"2025-05-28T11:19:48.735Z\",\n \"channel_id\": \"3f3fa530-fd3e-4018-ab98-4d9c3cd5406a\",\n \"deleted_at\": null,\n \"ticket_reference_id\": \"30569\",\n \"subject\": \"ticket com cc e cco\",\n \"who_is_viewing\": null,\n \"consumer_last_message\": null,\n \"processing\": false,\n \"who_is_viewing_user_id\": null,\n \"home_ticket_update_at\": \"2025-05-28T11:20:34.247Z\",\n \"requester_user\": {\n \"name\": \"email1@gmail.com\",\n \"lastname\": null\n },\n \"assigned_employee\": {\n \"name\": \"Alana\",\n \"lastname\": null\n },\n \"sector\": {\n \"id\": null,\n \"name\": null\n },\n \"bold\": false,\n \"last_message\": \"oi\",\n \"tags\": null,\n \"custom_fiejds\": null\n },\n {\n \"id\": \"33c8efe0-4ecc-4936-888a-5c94ce9c7b12\",\n \"status_id\": \"daddbd66-1dd2-4008-94c9-7fcb9b1a5800\",\n \"updated_at\": \"2025-05-28T17:18:03.021Z\",\n \"updated_level2_at\": \"2025-04-22T13:28:50.057Z\",\n \"channel_id\": \"33be81d8-88ac-4e08-bb4d-cf69fd23267f\",\n \"deleted_at\": null,\n \"ticket_reference_id\": \"30123\",\n \"subject\": \"WhatsApp\",\n \"who_is_viewing\": null,\n \"consumer_last_message\": \"2025-04-22T13:41:18.599Z\",\n \"processing\": false,\n \"who_is_viewing_user_id\": null,\n \"home_ticket_update_at\": \"2025-04-22T13:41:18.636Z\",\n \"requester_user\": {\n \"name\": \"Narciso\",\n \"lastname\": null\n },\n \"assigned_employee\": {\n \"name\": null,\n \"lastname\": null\n },\n \"sector\": {\n \"id\": \"4f5024e5-d88d-4ce6-8db6-e4f9a83a9f03\",\n \"name\": \"Setor\"\n },\n \"bold\": false,\n \"last_message\": \"atendimento humano\",\n \"tags\": null,\n \"custom_fiejds\": null\n }\n ],\n \"pagination\": {\n \"total\": 6,\n \"lastPage\": 1,\n \"prevPage\": null,\n \"nextPage\": null,\n \"perPage\": 100,\n \"currentPage\": 1,\n \"from\": 0,\n \"to\": 6\n }\n}"}],"_postman_id":"e0ed2f2f-b8a0-44eb-a4a6-bca67881bc62"},{"name":"List ticket history","id":"77e51521-b5b2-4095-b949-5b6f25b6a1b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/historic","description":"

Returns information on all completed services linked to the company. This endpoint includes:

Tickets completed after human service
\n
Tickets completed solely through chatbot service
\n
Telephony tickets, in which:
\n
- Calls were completed exclusively in the voicebot, or
  \n
- Calls were not answered by any human agent extension.
  \n
\n
Deleted tickets.
\n

Query parameters are available.

For each of the options listed above, this document contains versions with their respective filtering parameters. These endpoints are detailed further below in this document.

\n","urlObject":{"protocol":"https","path":["external","historic"],"host":["api","cxpress","io"],"query":[{"disabled":true,"description":{"content":"

Defines the maximum number of tickets to be returned per page.

\n","type":"text/plain"},"key":"limit","value":"integer > 0, opcional"},{"disabled":true,"description":{"content":"

Specifies the page number to be returned in the paginated list of tickets.

\n","type":"text/plain"},"key":"page","value":"integer > 0, opcional"},{"disabled":true,"description":{"content":"

Indicates the direction of the sorting. Allowed values: 'asc' (ascending order) or 'desc' (descending order).

\n","type":"text/plain"},"key":"order_by","value":"string, opcional"},{"disabled":true,"description":{"content":"

Defines the field by which results should be sorted. Currently supported values:\n'finished_at',\n'created_at',\n'updated_level2_at',\n'deleted_at',

\n","type":"text/plain"},"key":"sort_by","value":"string, opcional"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"status","value":"string, opcional"},{"disabled":true,"description":{"content":"

Filters the list to return tickets that belong to a specific channel. This parameter should be filled with a 'channel_id' value.

\n","type":"text/plain"},"key":"channel","value":"string, opcional"},{"disabled":true,"description":{"content":"

Filters the list to return tickets assigned to a specific operator. This parameter should be filled with a 'user_id' value.

\n","type":"text/plain"},"key":"employee","value":"string, opcional"},{"disabled":true,"description":{"content":"

Filters the list to return tickets that involved chatbot interaction. This parameter must be 'true' or 'false'.

\n","type":"text/plain"},"key":"bot","value":"boolean, opcional"},{"disabled":true,"description":{"content":"

Filters tickets by date range. Must be used in conjunction with 'end_date'.

\n","type":"text/plain"},"key":"start_date","value":"data no formato ISO 8601 ex.: YYYY-MM-DD, opcional"},{"disabled":true,"description":{"content":"

Filters tickets by date range. Must be used in conjunction with 'start_date'.

\n","type":"text/plain"},"key":"end_date","value":"data no formato ISO 8601 ex.: YYYY-MM-DD, opcional"},{"disabled":true,"description":{"content":"

Allows filtering of tickets based on a search string. The search is applied to the ticket field: 'ticket_reference_id' and the consumer fields: 'name', 'lastname', 'email', 'whatsapp', and 'phone'.

\n","type":"text/plain"},"key":"search","value":"string, opcional"},{"disabled":true,"description":{"content":"

Filters the list to return tickets that belong to a specific sector. This parameter should be filled with a 'sector_id' value.

\n","type":"text/plain"},"key":"sector","value":"string, opcional"},{"disabled":true,"description":{"content":"

Filters tickets based on an array of ticket tag IDs. Values should be comma-separated. Example: tag_id1,tag_id2,tag_id3.

\n","type":"text/plain"},"key":"tags","value":"string, opcional"},{"disabled":true,"description":{"content":"

Filters the list to return tickets that either belong to a sector or not. This parameter must be 'true'.

\n","type":"text/plain"},"key":"is_all_sectors","value":"boolean, opcional"},{"disabled":true,"description":{"content":"

Filters the list, returning only tickets that were deleted or not. This parameter must be set to \"true\".

\n","type":"text/plain"},"key":"deleted","value":"boolean, opcional"},{"disabled":true,"description":{"content":"

Filters the list, returning only the tickets according to the service level, as follows:\n1 for tickets completed exclusively via chatbot service and\n2 for tickets completed after human service

\n","type":"text/plain"},"key":"level","value":"integer > 0, opcional"},{"disabled":true,"description":{"content":"

Filters tickets based on an array of chatbot IDs. Values must be comma-separated. Example: bot_id1,bot_id2,bot_id3.

\n","type":"text/plain"},"key":"bot_id","value":"string, opcional"},{"disabled":true,"description":{"content":"

Filters the list, returning tickets that have tags or not. This parameter must be set to \"true\".

\n","type":"text/plain"},"key":"allTags","value":"boolean, opcional"}],"variable":[]}},"response":[{"id":"f3f0af34-92e8-46c5-a6d6-126685e6676b","name":"List ticket history","originalRequest":{"method":"GET","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"url":{"raw":"https://api.cxpress.io/external/historic","protocol":"https","host":["api","cxpress","io"],"path":["external","historic"],"query":[{"key":"limit","value":"integer > 0, opcional","description":"Defines the maximum number of tickets to be returned per page.","type":"text","disabled":true},{"key":"page","value":"integer > 0, opcional","description":"Specifies the page number to be returned in the paginated list of tickets.","type":"text","disabled":true},{"key":"order_by","value":"string, opcional","description":"Indicates the direction of the sorting. Allowed values: 'asc' (ascending order) or 'desc' (descending order).","type":"text","disabled":true},{"key":"sort_by","value":"string, opcional","description":"Defines the field by which results should be sorted. Currently supported values:\n'finished_at',\n'created_at',\n'updated_level2_at',\n'deleted_at',","type":"text","disabled":true},{"key":"status","value":"string, opcional","description":"Filters the list to return tickets with a specific status. This parameter should be filled with a 'status_id' value. With the ticket status value being:\nNew - daddbd66-1dd2-4008-94c9-7fcb9b1a5800\nOpen- b58c1105-0ffe-4d07-a7d6-751389fc3008\nPending - 0ec35dbb-398e-4c2f-996c-933af162c950\nOn Hold - 3dd9b9ac-7399-4ce8-b22c-a513eb473803\nResolved - 2b45ba71-fa68-4ce5-bf16-14f31d43ba1a\nAbandoned - 2f955a38-e8cf-4033-bf6c-c5e4f68c8ea9","type":"text","disabled":true},{"key":"channel","value":"string, opcional","description":"Filters the list to return tickets that belong to a specific channel. This parameter should be filled with a 'channel_id' value.","type":"text","disabled":true},{"key":"employee","value":"string, opcional","description":"Filters the list to return tickets assigned to a specific agent. This parameter should be filled with a 'user_id' value.","type":"text","disabled":true},{"key":"bot","value":"boolean, opcional","description":"Filters the list to return tickets that involved chatbot interaction. This parameter must be 'true' or 'false'.","type":"text","disabled":true},{"key":"start_date","value":"data no formato ISO 8601 ex.: YYYY-MM-DD, opcional","description":"Filters tickets by date range. Must be used in conjunction with 'end_date'.","type":"text","disabled":true},{"key":"end_date","value":"data no formato ISO 8601 ex.: YYYY-MM-DD, opcional","description":"Filters tickets by date range. Must be used in conjunction with 'start_date'.","type":"text","disabled":true},{"key":"search","value":"string, opcional","description":"Allows filtering of tickets based on a search string. The search is applied to the ticket field: 'ticket_reference_id' and the consumer fields: 'name', 'lastname', 'email', 'whatsapp', and 'phone'.","type":"text","disabled":true},{"key":"sector","value":"string, opcional","description":"Filters the list to return tickets that belong to a specific sector. This parameter should be filled with a 'sector_id' value.","type":"text","disabled":true},{"key":"tags","value":"string, opcional","description":"Filters tickets based on an array of ticket tag IDs. Values should be comma-separated. Example: tag_id1,tag_id2,tag_id3.","type":"text","disabled":true},{"key":"is_all_sectors","value":"boolean, opcional","description":"Filters the list to return tickets that either belong to a sector or not. This parameter must be 'true'.","type":"text","disabled":true},{"key":"deleted","value":"boolean, opcional","description":"Filters the list, returning only tickets that were deleted or not. This parameter must be set to \"true\".","type":"text","disabled":true},{"key":"level","value":"integer > 0, opcional","description":"Filters the list, returning only the tickets according to the service level, as follows:\n1 for tickets completed exclusively via chatbot service\n2 for tickets completed after human service","type":"text","disabled":true},{"key":"bot_id","value":"string, opcional","description":"Filters tickets based on an array of chatbot IDs. Values must be comma-separated. Example: bot_id1,bot_id2,bot_id3.","type":"text","disabled":true},{"key":"allTags","value":"boolean, opcional","description":"Filters the list, returning tickets that have tags or not. This parameter must be set to \"true\".","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Request successfully fulfilled.\",\n \"tickets\": [\n {\n \"id\": \"ff67b6df-a01e-484d-b0c8-e5f11143db2c\",\n \"ticket_reference_id\": \"28415\",\n \"updated_at\": \"2025-07-02T21:05:28.459Z\",\n \"created_at\": \"2025-02-06T14:06:41.324Z\",\n \"finished_at\": null,\n \"updated_level2_at\": null,\n \"deleted_at\": null,\n \"subject\": \"Facebook - Cx_test\",\n \"channel_id\": \"aa1cea93-23de-46aa-af14-d6f766acf5c8\",\n \"status_id\": \"2b45ba71-fa68-4ce5-bf16-14f31d43ba1a\",\n \"bot_cxpress_name\": \"Bot Cx_test\",\n \"requester_user\": {\n \"name\": \"João Pedro Santos\"\n },\n \"assigned_employee\": {\n \"name\": null\n },\n \"sector\": {\n \"id\": null,\n \"name\": null\n },\n \"last_message\": \"I understand, you'd like to speak with a human agent. Please hold a moment while I transfer you to the appropriate department. Would you like to speak with an agent?\"\n },\n {\n \"id\": \"8f61027c-3fa2-4b82-b497-6836059c46ce\",\n \"ticket_reference_id\": \"37826\",\n \"updated_at\": \"2025-11-07T12:24:27.252Z\",\n \"created_at\": \"2025-11-07T12:24:26.073Z\",\n \"finished_at\": \"2025-11-07T12:24:26.073Z\",\n \"updated_level2_at\": null,\n \"deleted_at\": null,\n \"subject\": \"TELEFONIA\",\n \"channel_id\": \"6977996d-11d1-44cc-a863-2e1d9c24e046\",\n \"status_id\": \"2b45ba71-fa68-4ce5-bf16-14f31d43ba1a\",\n \"bot_cxpress_name\": \"BOT-TELEFONIA\",\n \"requester_user\": {\n \"name\": \"5581999999999\"\n },\n \"assigned_employee\": {\n \"name\": null\n },\n \"sector\": {\n \"id\": null,\n \"name\": null\n },\n \"last_message\": \"Call Received from 5581999999999
\\n Call not answered by human
\\n Date/Time of call: Friday, November 7, 2025\"\n },\n {\n \"id\": \"74866b44-a65c-4fae-93d7-c2753d151d8c\",\n \"ticket_reference_id\": \"38666\",\n \"updated_at\": \"2025-12-02T14:18:55.243Z\",\n \"created_at\": \"2025-11-26T16:34:05.044Z\",\n \"finished_at\": \"2025-11-26T18:30:15.236Z\",\n \"updated_level2_at\": \"2025-11-26T16:34:05.044Z\",\n \"deleted_at\": null,\n \"subject\": \"Facebook - Page_cx_teste1\",\n \"channel_id\": \"aa1cea93-23de-46aa-af14-d6f766acf5c8\",\n \"status_id\": \"2f955a38-e8cf-4033-bf6c-c5e4f68c8ea9\",\n \"bot_cxpress_name\": null,\n \"requester_user\": {\n \"name\": \"Alana Tenório\"\n },\n \"assigned_employee\": {\n \"name\": \"ricardo agent\"\n },\n \"sector\": {\n \"id\": null,\n \"name\": null\n },\n \"last_message\": \"Teste Ari 03 - Alana:\\noi\"\n }\n ],\n \"pagination\": {\n \"total\": 3,\n \"lastPage\": null,\n \"prevPage\": null,\n \"nextPage\": 2,\n \"perPage\": 100,\n \"currentPage\": 1,\n \"from\": 0,\n \"to\": 100\n },\n \"code_cxpress\": 700\n}"}],"_postman_id":"77e51521-b5b2-4095-b949-5b6f25b6a1b7"},{"name":"List ticket history – Human attendace","id":"a8bf5e4f-b080-4cf2-bb4a-956007e0d883","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/historic?order_by=desc&sort_by=finished_at","description":"

Returns information on all services completed after human service linked to the company.

\n","urlObject":{"protocol":"https","path":["external","historic"],"host":["api","cxpress","io"],"query":[{"key":"order_by","value":"desc"},{"key":"sort_by","value":"finished_at"}],"variable":[]}},"response":[{"id":"10d55ffa-f1e6-4d0b-ae0f-4def250e25eb","name":"List ticket history – Human attendace","originalRequest":{"method":"GET","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"url":{"raw":"https://api.cxpress.io/external/historic?order_by=desc&sort_by=finished_at","protocol":"https","host":["api","cxpress","io"],"path":["external","historic"],"query":[{"key":"order_by","value":"desc"},{"key":"sort_by","value":"finished_at"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"message\": \"Request successfully fulfilled.\",\r\n\t\"tickets\": [\r\n\t\t{\r\n\t\t\t\"id\": \"c01d9b5b-be2b-48e3-86f2-90cbc0a5d0fe\",\r\n\t\t\t\"ticket_reference_id\": \"8\",\r\n\t\t\t\"updated_at\": \"2025-10-22T19:25:02.487Z\",\r\n\t\t\t\"created_at\": \"2025-10-20T19:23:38.863Z\",\r\n\t\t\t\"finished_at\": \"2025-10-22T19:25:02.487Z\",\r\n\t\t\t\"updated_level2_at\": \"2025-10-20T19:23:57.721Z\",\r\n\t\t\t\"deleted_at\": null,\r\n\t\t\t\"subject\": \"Webchat\",\r\n\t\t\t\"channel_id\": \"4a7b71bb-6432-4794-ad11-f978b067871d\",\r\n\t\t\t\"status_id\": \"2f955a38-e8cf-4033-bf6c-c5e4f68c8ea9\",\r\n\t\t\t\"bot_cxpress_name\": \"Teste\",\r\n\t\t\t\"requester_user\": {\r\n\t\t\t\t\"name\": \"Consumer Webchat 1760988218362\"\r\n\t\t\t},\r\n\t\t\t\"assigned_employee\": {\r\n\t\t\t\t\"name\": \"marcos teste\"\r\n\t\t\t},\r\n\t\t\t\"sector\": {\r\n\t\t\t\t\"id\": null,\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"last_message\": \"Beginning of human attendace\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"e5b8e46c-b2cc-4281-b6b2-e91f2bc76ffe\",\r\n\t\t\t\"ticket_reference_id\": \"7\",\r\n\t\t\t\"updated_at\": \"2025-08-10T19:25:09.633Z\",\r\n\t\t\t\"created_at\": \"2025-08-08T19:23:59.044Z\",\r\n\t\t\t\"finished_at\": \"2025-08-10T19:25:09.633Z\",\r\n\t\t\t\"updated_level2_at\": \"2025-08-08T19:24:11.414Z\",\r\n\t\t\t\"deleted_at\": null,\r\n\t\t\t\"subject\": \"Webchat\",\r\n\t\t\t\"channel_id\": \"4a7b71bb-6432-4794-ad11-f978b067871d\",\r\n\t\t\t\"status_id\": \"2f955a38-e8cf-4033-bf6c-c5e4f68c8ea9\",\r\n\t\t\t\"bot_cxpress_name\": \"Teste\",\r\n\t\t\t\"requester_user\": {\r\n\t\t\t\t\"name\": \"Consumer Webchat 1754681038630\"\r\n\t\t\t},\r\n\t\t\t\"assigned_employee\": {\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"sector\": {\r\n\t\t\t\t\"id\": null,\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"last_message\": \"Beginning of human attendace\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"52ddd64b-63a4-4d35-a2c0-64bf99f61b7d\",\r\n\t\t\t\"ticket_reference_id\": \"6\",\r\n\t\t\t\"updated_at\": \"2025-08-10T19:25:08.794Z\",\r\n\t\t\t\"created_at\": \"2025-08-08T19:23:15.564Z\",\r\n\t\t\t\"finished_at\": \"2025-08-10T19:25:08.794Z\",\r\n\t\t\t\"updated_level2_at\": \"2025-08-08T19:23:34.953Z\",\r\n\t\t\t\"deleted_at\": null,\r\n\t\t\t\"subject\": \"Webchat\",\r\n\t\t\t\"channel_id\": \"4a7b71bb-6432-4794-ad11-f978b067871d\",\r\n\t\t\t\"status_id\": \"2f955a38-e8cf-4033-bf6c-c5e4f68c8ea9\",\r\n\t\t\t\"bot_cxpress_name\": \"Teste\",\r\n\t\t\t\"requester_user\": {\r\n\t\t\t\t\"name\": \"Consumer Webchat 1754680995098\"\r\n\t\t\t},\r\n\t\t\t\"assigned_employee\": {\r\n\t\t\t\t\"name\": \"Marcos 2\"\r\n\t\t\t},\r\n\t\t\t\"sector\": {\r\n\t\t\t\t\"id\": null,\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"last_message\": \"Beginning of human attendace\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"9a9118f0-3bad-4c28-91e0-3463b5d55016\",\r\n\t\t\t\"ticket_reference_id\": \"3\",\r\n\t\t\t\"updated_at\": \"2025-08-10T19:25:08.055Z\",\r\n\t\t\t\"created_at\": \"2025-08-08T19:20:59.181Z\",\r\n\t\t\t\"finished_at\": \"2025-08-10T19:25:08.055Z\",\r\n\t\t\t\"updated_level2_at\": \"2025-08-08T19:21:09.436Z\",\r\n\t\t\t\"deleted_at\": null,\r\n\t\t\t\"subject\": \"Webchat\",\r\n\t\t\t\"channel_id\": \"4a7b71bb-6432-4794-ad11-f978b067871d\",\r\n\t\t\t\"status_id\": \"2f955a38-e8cf-4033-bf6c-c5e4f68c8ea9\",\r\n\t\t\t\"bot_cxpress_name\": \"Teste\",\r\n\t\t\t\"requester_user\": {\r\n\t\t\t\t\"name\": \"Consumer Webchat 1754680858794\"\r\n\t\t\t},\r\n\t\t\t\"assigned_employee\": {\r\n\t\t\t\t\"name\": \"Marcos 2\"\r\n\t\t\t},\r\n\t\t\t\"sector\": {\r\n\t\t\t\t\"id\": null,\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"last_message\": \"Beginning of human attendace\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"a523f1da-38f2-45bb-8ac3-ccf49df5bc85\",\r\n\t\t\t\"ticket_reference_id\": \"5\",\r\n\t\t\t\"updated_at\": \"2025-08-10T19:25:06.883Z\",\r\n\t\t\t\"created_at\": \"2025-08-08T19:22:12.887Z\",\r\n\t\t\t\"finished_at\": \"2025-08-10T19:25:06.883Z\",\r\n\t\t\t\"updated_level2_at\": \"2025-08-08T19:22:24.876Z\",\r\n\t\t\t\"deleted_at\": null,\r\n\t\t\t\"subject\": \"Webchat\",\r\n\t\t\t\"channel_id\": \"4a7b71bb-6432-4794-ad11-f978b067871d\",\r\n\t\t\t\"status_id\": \"2f955a38-e8cf-4033-bf6c-c5e4f68c8ea9\",\r\n\t\t\t\"bot_cxpress_name\": \"Teste\",\r\n\t\t\t\"requester_user\": {\r\n\t\t\t\t\"name\": \"Consumer Webchat 1754680932490\"\r\n\t\t\t},\r\n\t\t\t\"assigned_employee\": {\r\n\t\t\t\t\"name\": \"marcos teste\"\r\n\t\t\t},\r\n\t\t\t\"sector\": {\r\n\t\t\t\t\"id\": null,\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"last_message\": \"Beginning of human attendace\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"d7710caf-e0a6-4476-9a05-97fd1b1dba11\",\r\n\t\t\t\"ticket_reference_id\": \"2\",\r\n\t\t\t\"updated_at\": \"2025-08-10T19:25:06.061Z\",\r\n\t\t\t\"created_at\": \"2025-08-08T19:20:46.835Z\",\r\n\t\t\t\"finished_at\": \"2025-08-10T19:25:06.061Z\",\r\n\t\t\t\"updated_level2_at\": \"2025-08-08T19:20:55.693Z\",\r\n\t\t\t\"deleted_at\": null,\r\n\t\t\t\"subject\": \"Webchat\",\r\n\t\t\t\"channel_id\": \"4a7b71bb-6432-4794-ad11-f978b067871d\",\r\n\t\t\t\"status_id\": \"2f955a38-e8cf-4033-bf6c-c5e4f68c8ea9\",\r\n\t\t\t\"bot_cxpress_name\": \"Teste\",\r\n\t\t\t\"requester_user\": {\r\n\t\t\t\t\"name\": \"Consumer Webchat 1754680846367\"\r\n\t\t\t},\r\n\t\t\t\"assigned_employee\": {\r\n\t\t\t\t\"name\": \"marcos teste\"\r\n\t\t\t},\r\n\t\t\t\"sector\": {\r\n\t\t\t\t\"id\": null,\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"last_message\": \"Beginning of human attendace\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"2fd496d7-b2c7-466b-9058-b7702985149e\",\r\n\t\t\t\"ticket_reference_id\": \"4\",\r\n\t\t\t\"updated_at\": \"2025-08-10T19:25:04.900Z\",\r\n\t\t\t\"created_at\": \"2025-08-08T19:21:37.917Z\",\r\n\t\t\t\"finished_at\": \"2025-08-10T19:25:04.900Z\",\r\n\t\t\t\"updated_level2_at\": \"2025-08-08T19:21:48.848Z\",\r\n\t\t\t\"deleted_at\": null,\r\n\t\t\t\"subject\": \"Webchat\",\r\n\t\t\t\"channel_id\": \"4a7b71bb-6432-4794-ad11-f978b067871d\",\r\n\t\t\t\"status_id\": \"2f955a38-e8cf-4033-bf6c-c5e4f68c8ea9\",\r\n\t\t\t\"bot_cxpress_name\": \"Teste\",\r\n\t\t\t\"requester_user\": {\r\n\t\t\t\t\"name\": \"Consumer Webchat 1754680897504\"\r\n\t\t\t},\r\n\t\t\t\"assigned_employee\": {\r\n\t\t\t\t\"name\": \"marcos teste\"\r\n\t\t\t},\r\n\t\t\t\"sector\": {\r\n\t\t\t\t\"id\": null,\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"last_message\": \"Beginning of human attendace\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"6218ce7f-3edc-4c1e-858b-1e6654845adb\",\r\n\t\t\t\"ticket_reference_id\": \"1\",\r\n\t\t\t\"updated_at\": \"2025-08-10T19:25:03.811Z\",\r\n\t\t\t\"created_at\": \"2025-08-08T19:19:18.009Z\",\r\n\t\t\t\"finished_at\": \"2025-08-10T19:25:03.811Z\",\r\n\t\t\t\"updated_level2_at\": \"2025-08-08T19:20:05.199Z\",\r\n\t\t\t\"deleted_at\": null,\r\n\t\t\t\"subject\": \"Webchat\",\r\n\t\t\t\"channel_id\": \"4a7b71bb-6432-4794-ad11-f978b067871d\",\r\n\t\t\t\"status_id\": \"2f955a38-e8cf-4033-bf6c-c5e4f68c8ea9\",\r\n\t\t\t\"bot_cxpress_name\": \"Teste\",\r\n\t\t\t\"requester_user\": {\r\n\t\t\t\t\"name\": \"Consumer Webchat 1754680757520\"\r\n\t\t\t},\r\n\t\t\t\"assigned_employee\": {\r\n\t\t\t\t\"name\": \"Marcos 2\"\r\n\t\t\t},\r\n\t\t\t\"sector\": {\r\n\t\t\t\t\"id\": null,\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"last_message\": \"Beginning of human attendace\"\r\n\t\t}\r\n\t],\r\n\t\"pagination\": {\r\n\t\t\"total\": 8,\r\n\t\t\"lastPage\": 1,\r\n\t\t\"prevPage\": null,\r\n\t\t\"nextPage\": null,\r\n\t\t\"perPage\": 100,\r\n\t\t\"currentPage\": 1,\r\n\t\t\"from\": 0,\r\n\t\t\"to\": 8\r\n\t},\r\n\t\"code_cxpress\": 700\r\n}"}],"_postman_id":"a8bf5e4f-b080-4cf2-bb4a-956007e0d883"},{"name":"List ticket history – Chatbot attendace","id":"2ed6ab01-b8fd-4026-a614-a25455674685","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/historic?level=1&sort_by=finished_at&order_by=desc&channel=aa1cea93-23de-46aa-af14-d6f766acf5c8,f28cb4a4-e42b-425a-8011-59d5f9c1d0f2,33be81d8-88ac-4e08-bb4d-cf69fd23267f,4a7b71bb-6432-4794-ad11-f978b067871d","description":"

Returns information on all services completed solely through chatbot service linked to the company.

\n","urlObject":{"protocol":"https","path":["external","historic"],"host":["api","cxpress","io"],"query":[{"key":"level","value":"1"},{"key":"sort_by","value":"finished_at"},{"key":"order_by","value":"desc"},{"key":"channel","value":"aa1cea93-23de-46aa-af14-d6f766acf5c8,f28cb4a4-e42b-425a-8011-59d5f9c1d0f2,33be81d8-88ac-4e08-bb4d-cf69fd23267f,4a7b71bb-6432-4794-ad11-f978b067871d"}],"variable":[]}},"response":[{"id":"7721c704-ac0d-4f63-bdee-0ca15106cda7","name":"List ticket history – Chatbot attendace","originalRequest":{"method":"GET","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"url":{"raw":"https://api.cxpress.io/external/historic?level=1&sort_by=finished_at&order_by=desc&channel=aa1cea93-23de-46aa-af14-d6f766acf5c8,f28cb4a4-e42b-425a-8011-59d5f9c1d0f2,33be81d8-88ac-4e08-bb4d-cf69fd23267f,4a7b71bb-6432-4794-ad11-f978b067871d","protocol":"https","host":["api","cxpress","io"],"path":["external","historic"],"query":[{"key":"level","value":"1"},{"key":"sort_by","value":"finished_at"},{"key":"order_by","value":"desc"},{"key":"channel","value":"aa1cea93-23de-46aa-af14-d6f766acf5c8,f28cb4a4-e42b-425a-8011-59d5f9c1d0f2,33be81d8-88ac-4e08-bb4d-cf69fd23267f,4a7b71bb-6432-4794-ad11-f978b067871d"}]}},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n\t\"message\": \"Request successfully fulfilled.\",\r\n\t\"tickets\": [\r\n\t\t{\r\n\t\t\t\"id\": \"ff67b6df-a01e-484d-b0c8-e5f11143db2c\",\r\n\t\t\t\"ticket_reference_id\": \"28415\",\r\n\t\t\t\"updated_at\": \"2025-07-02T21:05:28.459Z\",\r\n\t\t\t\"created_at\": \"2025-02-06T14:06:41.324Z\",\r\n\t\t\t\"finished_at\": null,\r\n\t\t\t\"updated_level2_at\": null,\r\n\t\t\t\"deleted_at\": null,\r\n\t\t\t\"subject\": \"Facebook - Cx_test\",\r\n\t\t\t\"channel_id\": \"aa1cea93-23de-46aa-af14-d6f766acf5c8\",\r\n\t\t\t\"status_id\": \"2b45ba71-fa68-4ce5-bf16-14f31d43ba1a\",\r\n\t\t\t\"bot_cxpress_name\": \"Bot Cx_test\",\r\n\t\t\t\"requester_user\": {\r\n\t\t\t\t\"name\": \"João Pedro Santos\"\r\n\t\t\t},\r\n\t\t\t\"assigned_employee\": {\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"sector\": {\r\n\t\t\t\t\"id\": null,\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"last_message\": \"I understand, you'd like to speak with a human agent. Please hold a moment while I transfer you to the appropriate department. Would you like to speak with an agent?\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"d64c7e55-2385-4e55-a676-43fc890898c0\",\r\n\t\t\t\"ticket_reference_id\": \"28414\",\r\n\t\t\t\"updated_at\": \"2025-06-17T13:29:49.508Z\",\r\n\t\t\t\"created_at\": \"2025-02-06T14:06:09.981Z\",\r\n\t\t\t\"finished_at\": null,\r\n\t\t\t\"updated_level2_at\": null,\r\n\t\t\t\"deleted_at\": null,\r\n\t\t\t\"subject\": \"Facebook - Cx_test\",\r\n\t\t\t\"channel_id\": \"aa1cea93-23de-46aa-af14-d6f766acf5c8\",\r\n\t\t\t\"status_id\": \"2b45ba71-fa68-4ce5-bf16-14f31d43ba1a\",\r\n\t\t\t\"bot_cxpress_name\": \"Bot Cx_test\",\r\n\t\t\t\"requester_user\": {\r\n\t\t\t\t\"name\": \"João Pedro Santos\"\r\n\t\t\t},\r\n\t\t\t\"assigned_employee\": {\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"sector\": {\r\n\t\t\t\t\"id\": null,\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"last_message\": \"Hello, I'm Samir, the virtual assistant from Cxpress. Cxpress is a platform for managing/servicing customer service channels, providing a multichannel solution for your company.\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"fdb3a9f8-57cb-4adc-a679-b640b620a4d0\",\r\n\t\t\t\"ticket_reference_id\": \"28402\",\r\n\t\t\t\"updated_at\": \"2025-05-13T18:03:18.652Z\",\r\n\t\t\t\"created_at\": \"2025-02-06T13:38:55.199Z\",\r\n\t\t\t\"finished_at\": null,\r\n\t\t\t\"updated_level2_at\": null,\r\n\t\t\t\"deleted_at\": null,\r\n\t\t\t\"subject\": \"Facebook - Cx_test\",\r\n\t\t\t\"channel_id\": \"aa1cea93-23de-46aa-af14-d6f766acf5c8\",\r\n\t\t\t\"status_id\": \"2b45ba71-fa68-4ce5-bf16-14f31d43ba1a\",\r\n\t\t\t\"bot_cxpress_name\": \"Bot Cx_test\",\r\n\t\t\t\"requester_user\": {\r\n\t\t\t\t\"name\": \"João Pedro Santos\"\r\n\t\t\t},\r\n\t\t\t\"assigned_employee\": {\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"sector\": {\r\n\t\t\t\t\"id\": null,\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"last_message\": \"Hello, I'm Samir, the virtual assistant from Cxpress. Cxpress is a platform for managing/servicing customer service channels, providing a multichannel solution for your company. How can I...\"\r\n\t\t}\r\n ],\r\n\t\"pagination\": {\r\n\t\t\"total\": 3,\r\n\t\t\"lastPage\": null,\r\n\t\t\"prevPage\": null,\r\n\t\t\"nextPage\": 2,\r\n\t\t\"perPage\": 100,\r\n\t\t\"currentPage\": 1,\r\n\t\t\"from\": 0,\r\n\t\t\"to\": 100\r\n\t},\r\n\t\"code_cxpress\": 700\r\n}\r\n "}],"_postman_id":"2ed6ab01-b8fd-4026-a614-a25455674685"},{"name":"List ticket history – Telephony","id":"a81f5cf9-c88e-4ef3-a596-f4da935a6ae8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/historic?limit=25&page=1&level=1&sort_by=finished_at&order_by=desc&channel=6977996d-11d1-44cc-a863-2e1d9c24e046","description":"

Returns information on all telephony services that did not involve human service linked to the company. That is:

Calls were completed exclusively in the voicebot, or
\n
Calls were not answered by any human agent extension.
\n

\n","urlObject":{"protocol":"https","path":["external","historic"],"host":["api","cxpress","io"],"query":[{"key":"limit","value":"25"},{"key":"page","value":"1"},{"key":"level","value":"1"},{"key":"sort_by","value":"finished_at"},{"key":"order_by","value":"desc"},{"key":"channel","value":"6977996d-11d1-44cc-a863-2e1d9c24e046"}],"variable":[]}},"response":[{"id":"6ac60425-1df3-470c-b1c7-9c8b001a3f6a","name":"List ticket history – Telephony","originalRequest":{"method":"GET","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"url":{"raw":"https://api.cxpress.io/external/historic?limit=25&page=1&level=1&sort_by=finished_at&order_by=desc&channel=6977996d-11d1-44cc-a863-2e1d9c24e046","protocol":"https","host":["api","cxpress","io"],"path":["external","historic"],"query":[{"key":"limit","value":"25"},{"key":"page","value":"1"},{"key":"level","value":"1"},{"key":"sort_by","value":"finished_at"},{"key":"order_by","value":"desc"},{"key":"channel","value":"6977996d-11d1-44cc-a863-2e1d9c24e046"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n\t\"message\": \"Request successfully fulfilled.\",\r\n\t\"tickets\": [\r\n\t\t{\r\n\t\t\t\"id\": \"3b302549-be90-493c-866e-3fa9bf921234\",\r\n\t\t\t\"ticket_reference_id\": \"37828\",\r\n\t\t\t\"updated_at\": \"2025-11-07T12:25:40.355Z\",\r\n\t\t\t\"created_at\": \"2025-11-07T12:25:39.370Z\",\r\n\t\t\t\"finished_at\": \"2025-11-07T12:25:39.370Z\",\r\n\t\t\t\"updated_level2_at\": null,\r\n\t\t\t\"deleted_at\": null,\r\n\t\t\t\"subject\": \"TELEFONIA\",\r\n\t\t\t\"channel_id\": \"6977996d-11d1-44cc-a863-2e1d9c24e046\",\r\n\t\t\t\"status_id\": \"2b45ba71-fa68-4ce5-bf16-14f31d43ba1a\",\r\n\t\t\t\"bot_cxpress_name\": \"BOT-TELEFONIA\",\r\n\t\t\t\"requester_user\": {\r\n\t\t\t\t\"name\": \"5581999999999\"\r\n\t\t\t},\r\n\t\t\t\"assigned_employee\": {\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"sector\": {\r\n\t\t\t\t\"id\": null,\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"last_message\": \"Call Received from 5581999999999
\\n Call not answered by human
\\n Date/Time of call: Friday, November 7, 2025\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"35844f5f-c20c-4db5-bfbc-0e6db603c1a5\",\r\n\t\t\t\"ticket_reference_id\": \"37827\",\r\n\t\t\t\"updated_at\": \"2025-11-07T12:25:11.646Z\",\r\n\t\t\t\"created_at\": \"2025-11-07T12:25:10.319Z\",\r\n\t\t\t\"finished_at\": \"2025-11-07T12:25:10.319Z\",\r\n\t\t\t\"updated_level2_at\": null,\r\n\t\t\t\"deleted_at\": null,\r\n\t\t\t\"subject\": \"TELEFONIA\",\r\n\t\t\t\"channel_id\": \"6977996d-11d1-44cc-a863-2e1d9c24e046\",\r\n\t\t\t\"status_id\": \"2b45ba71-fa68-4ce5-bf16-14f31d43ba1a\",\r\n\t\t\t\"bot_cxpress_name\": \"BOT-TELEFONIA\",\r\n\t\t\t\"requester_user\": {\r\n\t\t\t\t\"name\": \"5581999999999\"\r\n\t\t\t},\r\n\t\t\t\"assigned_employee\": {\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"sector\": {\r\n\t\t\t\t\"id\": null,\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"last_message\": \"Call Received from 5581999999999
\\n Call not answered by human
\\n Date/Time of call: Friday, November 7, 2025\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"8f61027c-3fa2-4b82-b497-6836059c46ce\",\r\n\t\t\t\"ticket_reference_id\": \"37826\",\r\n\t\t\t\"updated_at\": \"2025-11-07T12:24:27.252Z\",\r\n\t\t\t\"created_at\": \"2025-11-07T12:24:26.073Z\",\r\n\t\t\t\"finished_at\": \"2025-11-07T12:24:26.073Z\",\r\n\t\t\t\"updated_level2_at\": null,\r\n\t\t\t\"deleted_at\": null,\r\n\t\t\t\"subject\": \"TELEFONIA\",\r\n\t\t\t\"channel_id\": \"6977996d-11d1-44cc-a863-2e1d9c24e046\",\r\n\t\t\t\"status_id\": \"2b45ba71-fa68-4ce5-bf16-14f31d43ba1a\",\r\n\t\t\t\"bot_cxpress_name\": \"BOT-TELEFONIA\",\r\n\t\t\t\"requester_user\": {\r\n\t\t\t\t\"name\": \"5581999999999\"\r\n\t\t\t},\r\n\t\t\t\"assigned_employee\": {\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"sector\": {\r\n\t\t\t\t\"id\": null,\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"last_message\": \"Call Received from 5581999999999
\\n Call not answered by human
\\n Date/Time of call: Friday, November 7, 2025\"\r\n\t\t}\r\n\t],\r\n\t\"pagination\": {\r\n\t\t\"total\": 3,\r\n\t\t\"lastPage\": null,\r\n\t\t\"prevPage\": null,\r\n\t\t\"nextPage\": 2,\r\n\t\t\"perPage\": 25,\r\n\t\t\"currentPage\": 1,\r\n\t\t\"from\": 0,\r\n\t\t\"to\": 25\r\n\t},\r\n\t\"code_cxpress\": 700\r\n}"}],"_postman_id":"a81f5cf9-c88e-4ef3-a596-f4da935a6ae8"},{"name":"List deleted ticket history","id":"f96b9d98-e04c-446a-b6ce-d479fece6d58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/historic?order_by=desc&sort_by=deleted_at&deleted=true","description":"

Returns information on all services deleted via the Cxpress interface linked to the company.

\n","urlObject":{"protocol":"https","path":["external","historic"],"host":["api","cxpress","io"],"query":[{"key":"order_by","value":"desc"},{"key":"sort_by","value":"deleted_at"},{"key":"deleted","value":"true"}],"variable":[]}},"response":[{"id":"e326fc26-5c5d-4270-9b6b-16aa6447dac3","name":"List deleted ticket history","originalRequest":{"method":"GET","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"url":{"raw":"https://api.cxpress.io/external/historic?order_by=desc&sort_by=deleted_at&deleted=true","protocol":"https","host":["api","cxpress","io"],"path":["external","historic"],"query":[{"key":"order_by","value":"desc"},{"key":"sort_by","value":"deleted_at"},{"key":"deleted","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n\t\"message\": \"Request successfully fulfilled.\",\r\n\t\"tickets\": [\r\n\t\t{\r\n\t\t\t\"id\": \"10d0f5a7-cdd1-42dd-b993-464ccc972889\",\r\n\t\t\t\"ticket_reference_id\": \"38739\",\r\n\t\t\t\"updated_at\": \"2025-12-03T18:38:14.884Z\",\r\n\t\t\t\"created_at\": \"2025-12-03T18:23:55.741Z\",\r\n\t\t\t\"finished_at\": null,\r\n\t\t\t\"updated_level2_at\": \"2025-12-03T18:25:57.043Z\",\r\n\t\t\t\"deleted_at\": \"2025-12-03T18:38:14.884Z\",\r\n\t\t\t\"subject\": \"Facebook - NLP Staging\",\r\n\t\t\t\"channel_id\": \"aa1cea93-23de-46aa-af14-d6f766acf5c8\",\r\n\t\t\t\"status_id\": \"daddbd66-1dd2-4008-94c9-7fcb9b1a5800\",\r\n\t\t\t\"bot_cxpress_name\": \"Facebook Samir -NLP staging\",\r\n\t\t\t\"requester_user\": {\r\n\t\t\t\t\"name\": \"pular\"\r\n\t\t\t},\r\n\t\t\t\"assigned_employee\": {\r\n\t\t\t\t\"name\": \"Beth\"\r\n\t\t\t},\r\n\t\t\t\"sector\": {\r\n\t\t\t\t\"id\": null,\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"last_message\": \"Bye\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"1e7596ef-2b76-4a4a-ae5f-bec4d4bd6e98\",\r\n\t\t\t\"ticket_reference_id\": \"38725\",\r\n\t\t\t\"updated_at\": \"2025-12-03T10:51:25.357Z\",\r\n\t\t\t\"created_at\": \"2025-12-03T10:45:41.439Z\",\r\n\t\t\t\"finished_at\": null,\r\n\t\t\t\"updated_level2_at\": \"2025-12-03T10:47:51.907Z\",\r\n\t\t\t\"deleted_at\": \"2025-12-03T10:51:11.642Z\",\r\n\t\t\t\"subject\": \"Facebook - NLP Staging\",\r\n\t\t\t\"channel_id\": \"aa1cea93-23de-46aa-af14-d6f766acf5c8\",\r\n\t\t\t\"status_id\": \"daddbd66-1dd2-4008-94c9-7fcb9b1a5800\",\r\n\t\t\t\"bot_cxpress_name\": \"Facebook Samir -NLP staging\",\r\n\t\t\t\"requester_user\": {\r\n\t\t\t\t\"name\": \"alana\"\r\n\t\t\t},\r\n\t\t\t\"assigned_employee\": {\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"sector\": {\r\n\t\t\t\t\"id\": null,\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"last_message\": \"Bye\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"328634ba-6d4b-41df-8854-e806837dc6d5\",\r\n\t\t\t\"ticket_reference_id\": \"38724\",\r\n\t\t\t\"updated_at\": \"2025-12-03T10:45:29.506Z\",\r\n\t\t\t\"created_at\": \"2025-12-03T10:44:05.253Z\",\r\n\t\t\t\"finished_at\": null,\r\n\t\t\t\"updated_level2_at\": \"2025-12-03T10:45:08.362Z\",\r\n\t\t\t\"deleted_at\": \"2025-12-03T10:45:28.920Z\",\r\n\t\t\t\"subject\": \"Facebook - NLP Staging\",\r\n\t\t\t\"channel_id\": \"aa1cea93-23de-46aa-af14-d6f766acf5c8\",\r\n\t\t\t\"status_id\": \"daddbd66-1dd2-4008-94c9-7fcb9b1a5800\",\r\n\t\t\t\"bot_cxpress_name\": \"Facebook Samir -NLP staging\",\r\n\t\t\t\"requester_user\": {\r\n\t\t\t\t\"name\": \"alana\"\r\n\t\t\t},\r\n\t\t\t\"assigned_employee\": {\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"sector\": {\r\n\t\t\t\t\"id\": null,\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"last_message\": \"Bye\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"13998761-7f2f-4681-b7aa-50a1c931dd47\",\r\n\t\t\t\"ticket_reference_id\": \"38723\",\r\n\t\t\t\"updated_at\": \"2025-12-03T10:42:48.018Z\",\r\n\t\t\t\"created_at\": \"2025-12-03T10:41:06.274Z\",\r\n\t\t\t\"finished_at\": null,\r\n\t\t\t\"updated_level2_at\": \"2025-12-03T10:42:18.780Z\",\r\n\t\t\t\"deleted_at\": \"2025-12-03T10:42:47.493Z\",\r\n\t\t\t\"subject\": \"Facebook - NLP Staging\",\r\n\t\t\t\"channel_id\": \"aa1cea93-23de-46aa-af14-d6f766acf5c8\",\r\n\t\t\t\"status_id\": \"0ec35dbb-398e-4c2f-996c-933af162c950\",\r\n\t\t\t\"bot_cxpress_name\": \"Facebook Samir -NLP staging\",\r\n\t\t\t\"requester_user\": {\r\n\t\t\t\t\"name\": \"alana\"\r\n\t\t\t},\r\n\t\t\t\"assigned_employee\": {\r\n\t\t\t\t\"name\": \"Alana\"\r\n\t\t\t},\r\n\t\t\t\"sector\": {\r\n\t\t\t\t\"id\": null,\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"last_message\": \"Teste Ari 03 - Alana:\\noi\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"99a7ce6a-9762-4b7d-b4ac-7e987111f06d\",\r\n\t\t\t\"ticket_reference_id\": \"38453\",\r\n\t\t\t\"updated_at\": \"2025-12-02T18:12:38.191Z\",\r\n\t\t\t\"created_at\": \"2025-11-17T18:09:28.331Z\",\r\n\t\t\t\"finished_at\": null,\r\n\t\t\t\"updated_level2_at\": \"2025-11-17T18:17:24.875Z\",\r\n\t\t\t\"deleted_at\": \"2025-12-02T18:12:38.191Z\",\r\n\t\t\t\"subject\": \"WhatsApp\",\r\n\t\t\t\"channel_id\": \"33be81d8-88ac-4e08-bb4d-cf69fd23267f\",\r\n\t\t\t\"status_id\": \"daddbd66-1dd2-4008-94c9-7fcb9b1a5800\",\r\n\t\t\t\"bot_cxpress_name\": \"Twilio com bot - 8965\",\r\n\t\t\t\"requester_user\": {\r\n\t\t\t\t\"name\": \"usuário 5572857803760\"\r\n\t\t\t},\r\n\t\t\t\"assigned_employee\": {\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"sector\": {\r\n\t\t\t\t\"id\": null,\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"last_message\": \"Hello, thank you for contacting us, you are special.\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"9adcc30e-d1c5-4cd0-8ba0-a0c341f3b015\",\r\n\t\t\t\"ticket_reference_id\": \"38714\",\r\n\t\t\t\"updated_at\": \"2025-12-02T12:58:51.528Z\",\r\n\t\t\t\"created_at\": \"2025-12-02T12:56:08.129Z\",\r\n\t\t\t\"finished_at\": null,\r\n\t\t\t\"updated_level2_at\": \"2025-12-02T12:58:32.517Z\",\r\n\t\t\t\"deleted_at\": \"2025-12-02T12:58:51.528Z\",\r\n\t\t\t\"subject\": \"Facebook - NLP Staging\",\r\n\t\t\t\"channel_id\": \"aa1cea93-23de-46aa-af14-d6f766acf5c8\",\r\n\t\t\t\"status_id\": \"daddbd66-1dd2-4008-94c9-7fcb9b1a5800\",\r\n\t\t\t\"bot_cxpress_name\": \"Facebook Samir -NLP staging\",\r\n\t\t\t\"requester_user\": {\r\n\t\t\t\t\"name\": \"pular\"\r\n\t\t\t},\r\n\t\t\t\"assigned_employee\": {\r\n\t\t\t\t\"name\": \"Beth\"\r\n\t\t\t},\r\n\t\t\t\"sector\": {\r\n\t\t\t\t\"id\": null,\r\n\t\t\t\t\"name\": null\r\n\t\t\t},\r\n\t\t\t\"last_message\": \"In attendace\"\r\n\t\t}\r\n ],\r\n\t\"pagination\": {\r\n\t\t\"total\": 6,\r\n\t\t\"lastPage\": null,\r\n\t\t\"prevPage\": null,\r\n\t\t\"nextPage\": 2,\r\n\t\t\"perPage\": 100,\r\n\t\t\"currentPage\": 1,\r\n\t\t\"from\": 0,\r\n\t\t\"to\": 100\r\n\t},\r\n\t\"code_cxpress\": 700\r\n}"}],"_postman_id":"f96b9d98-e04c-446a-b6ce-d479fece6d58"},{"name":"List tickets of an operator","id":"8499aa88-967f-41ef-8a7d-ca34a7e8e11d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Origin","value":"https://{Your domain}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/agent/{user_id}/tickets","description":"

Returns information on all ongoing and completed services for a specific agent linked to the company.

Supports query parameters.

Note: Deleted tickets are not included in this endpoint.

\n","urlObject":{"protocol":"https","path":["external","agent","{user_id}","tickets"],"host":["api","cxpress","io"],"query":[{"disabled":true,"description":{"content":"