{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"f6668c5a-9bc7-44ad-a3c2-c4c78b736367","name":"API Cxpress","description":"[Portuguese version (BR)](https://documenter.getpostman.com/view/45421173/2sB2qi8HcV)\n\n[Spanish version (neutral latin)](https://documenter.getpostman.com/view/45421173/2sB2x6mXha)\n\nWelcome to the Cxpress Integration API Documentation\n\nThis 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.\n\n### **Structure**\n\n1. The documentation is organised by versions, prioritising the most recent version of the API.\n \n2. 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 \n3. 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 \n\n# **Creating an Integration Entity**\n\nTo create a new integration entity, a user with the COMPANY OWNER profile must follow the path below within the platform:\n\n**Sidebar Menu → Configurations → Company → API**\n\n\n\nOn the API screen, click the button located in the upper corner of the interface:\n\n\n\nWhen this button is clicked, a modal will be displayed where the following information must be provided:\n\n- **Token name**: Identification name for the integration entity.\n \n- **Permissions**: Selection of the endpoints the token will be allowed to access.\n \n\n\n\nOnce 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.\n\n⚠️ **Important**: Tokens are displayed only once after creation. Ensure they are stored securely.\n\n\n\n#### **Token Validity and Management**\n\n- The **API Token** is valid for 1 hour. After this period, it is automatically invalidated.\n \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 \n\nThe 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\n\nThe **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.\n\n# **Webhook Configuration**\n\nThe webhook functionality allows external systems to be automatically notified whenever specific events occur within the Cxpress platform.\n\nOn the API screen, click the button located above the token listing:\n\n\n\n#### **Configuration Fields**\n\nWhen this button is clicked, a modal will appear where the following information must be filled in:\n\n- **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 \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 \n - **Creation (**`create`**)** – Triggered when one of the available entities is created in Cxpress.\n \n - **Update (**`update`**)** – Triggered when one of the available entities is modified in Cxpress.\n \n\n\n\n#### **Available Entities**\n\nWebhook notifications cover events related to the following entity types:\n\n- Consumer\n \n- Ticket\n \n- Task\n \n- Department\n \n- Ticket Tags\n \n- Consumer Tags\n \n- Custom Fields\n \n\n#### **How It Works**\n\nWhen 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.\n\nThe request payload will include the updated or newly created data of the entity, allowing the external system to respond to changes in real time.\n\n#### **Example Use Case**\n\nWhen 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.\n\nFor example, in the case of a creation event for the **Department** entity, the request body will be structured as follows:\n\n``` json\n{\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 ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"45421173","collectionId":"f6668c5a-9bc7-44ad-a3c2-c4c78b736367","publishedId":"2sB2x6msBP","public":true,"publicUrl":"https://documenter-api.postman.tech/view/45421173/2sB2x6msBP","privateUrl":"https://go.postman.co/documentation/45421173-f6668c5a-9bc7-44ad-a3c2-c4c78b736367","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"232960"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/2d0a2d79-3b74-4f12-95c9-46070cba97f8/Q1hwcmVzcy1sb2dvLXdodC5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"232960"}},{"name":"light","logo":"https://content.pstmn.io/fc5d4583-c6b1-468b-b0f5-0253c93a98e6/Q1hwcmVzcy1sb2dvICgyKS5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"232960"}}]}},"version":"8.10.0","publishDate":"2025-06-13T17:50:42.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/fc5d4583-c6b1-468b-b0f5-0253c93a98e6/Q1hwcmVzcy1sb2dvICgyKS5wbmc=","logoDark":"https://content.pstmn.io/2d0a2d79-3b74-4f12-95c9-46070cba97f8/Q1hwcmVzcy1sb2dvLXdodC5wbmc="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sB2x6msBP"}