{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a2d563ef-e168-4673-b271-c8b9e777cd87","name":"CustomerX - API","description":"É um serviço fornecido pela [CustomerX](https://customerx.cx/), para que nossos clientes possam integrar seus softwares a nossa aplicação.\n\n## Como ser atendido se eu tiver dúvidas?\n\n- Suporte API: Abra um chamado enviando um e-mail para:\n    \n    - [suporte@customerx.cx](https://suporte@customerx.cx)\n        \n- Visite nosso site: [https://customerx.cx](https://customerx.cx/)\n    \n\nMais informações:\n\n- Sobre [API REST clique aqui](https://pt.wikipedia.org/wiki/REST)\n    \n- Retornos em JSON codificados com Unicode\n    \n- Datas em formato DD/MM/AAAA\n    \n- Números com \".\" como separadores decimais, sem separadores milhares e com o sinal \"-\" representando valores negativos\n    \n\n## Há separação entre ambiente de teste e produção?\n\nSim, temos um ambiente para teste!\n\n- **Sandbox**: `https://sandbox.api.customerx.com.br` - \\[Download Postman\\]\n    \n\n**Atenção:** _A base do sandbox será resetada todo o primeiro dia do mês (dia 1)._\n\n## O status do HTTP tem significado?\n\nSim. É importante uma correta validação deste status considerando que um valor maior ou igual a 300 sempre representa um erro. Os status seguem o padrão do HTTP e os mais comuns são:\n\n- O status `200` significa processamento realizado com sucesso sem ressalvas;\n    \n- O status `201` significa que algo solicitado foi criado com sucesso;\n    \n- O status `400` significa que algo fornecido da parte do usuário não corresponde com o esperado;\n    \n- O Status `401` significa que algo está errado com a autenticação;\n    \n- O status `404` significa que o recurso solicitado não foi encontrado;\n    \n- O status `422` significa que a entidade não pôde ser processada;\n    \n- O status `429` significa que o limite de requisições foi atingido;\n    \n- O status `500` significa que algo deu errado no servidor.\n    \n\n---\n\n## Como funciona a API?\n\nÉ uma API REST, ou seja, há diversos recursos, cada qual com sua URL. Os recursos podem ser acessados e alterados usando operações padrões do HTTP como `GET`(listar ou exibir) e `POST` (criar um recurso).\n\n**Obs**  \n\\- Toda a requisicão enviada, deve ter o corpo `body` no formato `JSON`\n\n## Autenticação na API?\n\nPossuimos autenticação via API_TOKEN que funciona da seguinte forma:\n\n**api_token**\n\nPara realizar está autenticação deverá ser informado no header de qualquer request o paremetro `Authorization` - `2721a3bf511231b25df141cf8e9539a7`, cada um usuário possui um api_token unico, este pode ser buscado pelo cadastro do sistema em:\n\n- No menu superior direto Usuário\n    \n- Ver Perfil\n    \n- Campo de Api Token\n    \n\n<img src=\"https://customerx-files.s3-us-west-2.amazonaws.com/api_token.png\" alt=\"alt text\">\n\n---\n\n# Changelog\n\n### 2026.08.26\n\n- \\[[Clientes](https://doc.api.customerx.com.br/?version=latest#cab11947-f8ce-42bc-ac55-3800fc425e18)\\] - Adicionado filtro por lista de ID Externo de clientes `external_id_client`.\n    \n    - \\[[Buscar](https://doc.api.customerx.com.br/?version=latest#276f1af5-fadd-4b44-82b5-236af1738c8c)\\] - `filter_external_ids`\n        \n- \\[[Financeiro](https://doc.api.customerx.com.br/?version=latest#30b89fc6-abc5-4345-9b5b-2b8a6f25e664)\\] - Adicionado paremetro no financeiro `additional_value`.\n    \n- Implementado Retry-After para quando é esgotado o limite de request do plano.\n    \n    - Obs: Esse campo só é exibido quando chega no limite e a request retorna erro 429.\n        \n- Implementado nas rotas de listagem uma ordenação padrão pelo ID da entidade buscada.\n    \n- Implementado validador nas rotas de listagem para processar a busca apenas se os parametros enviados são reconhecidos, caso não seja, é retornado um erro 422 com o parametro errado.\n    \n\n### 2026.06.19\n\n- \\[[Busca de Clientes](https://doc.api.customerx.com.br/?version=latest#276f1af5-fadd-4b44-82b5-236af1738c8c)\\] - Adicionado filtro por site na busca de clientes.\n    \n\n### 2026.05.21\n\n- \\[[Tarefas do Cliente](https://doc.api.customerx.com.br/#ad92825e-f75d-42b9-838d-ce99adba8017)\\] - Adicionado novos filtros.\n    \n\n### 2026.05.15\n\n- \\[[Board CSM Steps](https://doc.api.customerx.com.br/?version=latest#25ca1908-7860-4253-972e-bb14c47cbadf)\\] - Adicionado novos filtros e atualizado rotas.\n    \n\n### 2026.05.05\n\n- \\[[Campos Personalizados do Cliente](https://doc.api.customerx.com.br/?version=latest#ba314541-6765-47f1-8785-6a98b529d59b)\\] - Adicionado rota buscar um valor de campos personalizados de um cliente\n    \n\n### 2026.04.29\n\n- \\[[Tarefas da Jornada](https://doc.api.customerx.com.br/?version=latest#c76f8a81-7415-4d13-9ce5-d55da37365f4)\\] - Adicionado novas rotas para gestão de tarefas das jornadas.\n    \n    - [Concluir](https://doc.api.customerx.com.br/?version=latest#53076a34-deb0-4efc-aea9-9dc9cc0bf5a3) - Lista das tarefas das jornadas\n        \n- \\[[Tags da Tarefa](https://doc.api.customerx.com.br/?version=latest#3f789341-2fca-4fc2-b288-04baec0cb04d)\\] - Adicionado novas rotas para gestão das tags de tarefas das jornadas.\n    \n    - [Vincular](https://doc.api.customerx.com.br/?version=latest#0d8f8bbc-12d8-43ac-b445-14667095dc5e) - Vincular uma ou mais tags em uma tarefa.\n        \n    - [Desvincular](https://doc.api.customerx.com.br/?version=latest#ea83a71a-74f6-4495-bba1-07846ba08cc6) - Remover uma ou mais tags de um tarefa.\n        \n\n### 2026.04.09\n\n- \\[[Campos Personalizados do Cliente](https://doc.api.customerx.com.br/?version=latest#cdcba3b5-8576-4267-afb2-1dff41f1ff2d)\\] - Adicionado rota para cadastrar ou atualizar valor de campos personalizados no cliente\n    \n    - [Cadastrar ou Atualizar](https://doc.api.customerx.com.br/?version=latest#7628872c-3515-4868-b6f0-279500e7e46c) - Nova rota que vincula um campo personalizado no cliente ou atualiza o valor do campo.\n        \n\n### 2026.03.05\n\n- \\[[Financeiro](https://doc.api.customerx.com.br/?version=latest#30b89fc6-abc5-4345-9b5b-2b8a6f25e664)\\] - Adicionado filtro na rota de listagem\n    \n    - [Listagem](https://doc.api.customerx.com.br/?version=latest#9003e023-03af-4ea5-92b9-11906313e48e) - `filter_statuses` Fitra os registros de financeiro por status.\n        \n\n### 2026.02.20\n\n- \\[[Tarefas do Cliente](https://doc.api.customerx.com.br/?version=latest#ad92825e-f75d-42b9-838d-ce99adba8017)\\] - Adicionado rota para listagem de todos os tipos tarefas vinculadas ao cliente.\n    \n\n### 2026.02.03\n\n- \\[[Tarefas da Jornada](https://doc.api.customerx.com.br/?version=latest#c76f8a81-7415-4d13-9ce5-d55da37365f4)\\] - Adicionado filtro na listagem de tarefas da jornada.\n    \n    - `filter_journeys_clients` que irá buscar as tarefas com base no ID do vinculo de jornada com o cliente, o do campo no retorno é `journeys_client_id`\n        \n\n### 2026.02.03\n\n- \\[[Tarefas da Jornada](https://doc.api.customerx.com.br/?version=latest#c76f8a81-7415-4d13-9ce5-d55da37365f4)\\] - Adicionado novas rotas para gestão de tarefas das jornadas.\n    \n    - [Listagem](https://doc.api.customerx.com.br/?version=latest#280c09e8-d646-4086-a539-a3f0a7c78c6d) - Lista das tarefas das jornadas\n        \n    - [Detalhe](https://doc.api.customerx.com.br/?version=latest#65b25842-8616-46e4-84c1-a8110f3ae024) - Detalha uma tarefa especifica.\n        \n    - [Cadastro](https://doc.api.customerx.com.br/?version=latest#bad315a7-dce8-45be-bc1d-9edb78fa8d65) - Cadastro de uma nova tarefa.\n        \n    - [Atualização](https://doc.api.customerx.com.br/?version=latest#7f3027cf-4285-4363-b5ec-9f83039ccfee) - Atualiza uma tarefa já cadastrada.\n        \n    - [Exclusão](https://doc.api.customerx.com.br/?version=latest#941fa798-394e-4db7-b99d-56ad20a9cc12) - Exclusão uma tarefa.\n        \n- \\[[Comentários da Tarefa](https://doc.api.customerx.com.br/?version=latest#5fb6d9fb-5e6e-4644-a6f6-66e0c08dff5d)\\] - Adicionado novas rotas para gestão de comentários de tarefas das jornadas.\n    \n    - [Listagem](https://doc.api.customerx.com.br/?version=latest#fac42ad2-3646-4adb-9b82-9c924054f295) - Lista os comentários de uma tarefa.\n        \n    - [Detalhe](https://doc.api.customerx.com.br/?version=latest#d3dad43b-e0fa-4747-94de-78f5befa3591) - Detalhe de um comentário.\n        \n    - [Cadastro](https://doc.api.customerx.com.br/?version=latest#ae209b94-a604-4279-b980-ec80a74538c0) - Cadastro de um novo comentário em uma tarefa.\n        \n    - [Atualização](https://doc.api.customerx.com.br/?version=latest#0fc3ffff-ab4f-40cd-8d3c-a3cb4d8c6ced) - Atualiza um comentário já cadastrado.\n        \n    - [Exclusão](https://doc.api.customerx.com.br/?version=latest#f7febb4b-7c27-4ef4-8105-6426fec69634) - Exclusão de um comentário.\n        \n\n### 2026.01.26\n\n- \\[[Responsável do Cliente ](https://doc.api.customerx.com.br/?version=latest#35a38e18-8048-4cdb-b921-d3d703f18143) \\] - Adicionado rotas de listagem, cadastro/atualização e remoção de responsáveis do cliente.\n    \n    - [Listagem](https://doc.api.customerx.com.br/?version=latest#c6fe4cf7-2a70-4956-a000-fb15770937fb) - Lista os responsáveis.\n        \n    - [Cadastro ou Atualização](https://doc.api.customerx.com.br/?version=latest#5723e3eb-4cc7-4f4d-9a1c-fe8ea31249a0) - Cadastra ou atualiza o responsável.\n        \n    - [Remoção ](https://doc.api.customerx.com.br/?version=latest#ca0730bb-6862-4eeb-9221-b65241a4f1c9) \\- Remove o responsável.\n        \n\n### 2025.12.29\n\n- \\[[Jornadas do Cliente](https://doc.api.customerx.com.br/?version=latest#13c6f240-c8d5-4e92-b3fb-bfebbcaf5b8e)\\] - Adicionado campo no retorno das requisições o campo `customers_follow_ups_progress` que irá mostrar as listas/etapas de cada jornada e o progresso de atual da lista/etapa\n    \n\n### 2025.12.02\n\n- \\[[Jornadas do Cliente](https://doc.api.customerx.com.br/?version=latest#243dc7ea-4c41-4d70-a884-baa68a3e6201)\\] - Adicionado rotas de listagem, cadastro e remoção de jornadas no cliente.\n    \n    - [Listagem](https://doc.api.customerx.com.br/?version=latest#13c6f240-c8d5-4e92-b3fb-bfebbcaf5b8e) - Lista as jornadas vinculadas no cliente.\n        \n    - [Cadastro](https://doc.api.customerx.com.br/?version=latest#c2eef5dc-a3a4-4398-b513-5857368f117d) - Cria uma jornada no cliente.\n        \n    - [Remoção](https://doc.api.customerx.com.br/?version=latest#a330d335-df86-4b8e-aa1c-c502f45c8b86) - Remove a jornada do cliente.\n        \n\n### 2025.11.17\n\n- \\[[Campos Personalizados](https://doc.api.customerx.com.br/?version=latest#20f96aa5-d4fe-4fb4-8a82-f2c32a3580ae)\\] - Adicionado rota para listagem de campos personalizados.\n    \n\n### 2025.07.23\n\n- \\[[Webhooks](https://doc.api.customerx.com.br/#4e33715e-3bb7-4fe1-91c0-998a469c7078)\\] - Adicionado rotas para criação/atualização/busca/remoção e logs de webhooks.\n    \n\n### 2025.07.21\n\n- \\[[Tarefas do Cliente](https://doc.api.customerx.com.br/?version=latest#280c09e8-d646-4086-a539-a3f0a7c78c6d)\\] - Feito melhorias nas rotas de tags no clientes para cadastro de as mesmas nos clientes usando o External ID e ID do cliente.\n    \n    - Filtro para listar as tarefas apenas da etapa atual do cliente.\n        \n        - `filter_only_by_current_step`\n            \n    - Parâmetro para incluir no retorno os checklist no retorno das tarefas, default=false.\n        \n        - `include_checklists`\n            \n- \\[[Históricos de Associações](https://doc.api.customerx.com.br/?version=latest#032be0f2-b430-474a-8367-9ab5c028d412)\\] - Criado nova rota para listar o histórico das associações de clientes e tags.\n    \n    - Com fitros obrigatórios de clientes ou tag\n        \n        - Cliente: `filter_client_id` OU `filter_external_id_client`\n            \n        - Tag: `filter_tag_id`\n            \n    - Filtro opcional de data de associação.\n        \n        - `filter_between_added_date`\n            \n\n### 2025.05.08\n\n- \\[[Clientes](https://doc.api.customerx.com.br/?version=latest#cab11947-f8ce-42bc-ac55-3800fc425e18)\\] - Adicionado parâmetros nas rotas de cadastro e atualização para cadastrar clientes em uma carteira a partir do external_id da carteira.\n    \n    - `external_id_portfolio`\n        \n\n### 2025.04.01\n\n- \\[[Tarefas da Jornada](https://doc.api.customerx.com.br/?version=latest#c76f8a81-7415-4d13-9ce5-d55da37365f4)\\] - Adicionado parâmetros de buscar por data de agendamento, conclusão, responsável da tarefa, criador e o relator.\n    \n    - Filtro por data de agendamento:\n        \n        - `filter_between_date_scheduled[date_initial]`\n            \n        - `filter_between_date_scheduled[date_final]`\n            \n    - Filtro por data de conclusão:\n        \n        - `filter_between_date_closure[date_initial]`\n            \n        - `filter_between_date_closure[date_final]`\n            \n    - Filtro do responsável da tarefa\n        \n        - `filter_user`\n            \n    - Filtro do criador da tarefa\n        \n        - `filter_creator`\n            \n    - Filtro do relator da tarefa.\n        \n        - `filter_reporter`\n            \n- \\[[Tarefas](https://doc.api.customerx.com.br/?version=latest#601db571-1c31-4f1d-8d4d-9f3680b45c88)\\] - Adiciona parâmetros de buscar por data de agendamento, conclusão, responsável da tarefa.\n    \n    - Filtro por data de agendamento:\n        \n        - `filter_between_date_scheduled[date_initial]`\n            \n        - `filter_between_date_scheduled[date_final]`\n            \n    - Filtro por data de conclusão:\n        \n        - `filter_between_date_closure[date_initial]`\n            \n        - `filter_between_date_closure[date_final]`\n            \n    - Filtro do responsável da tarefa\n        \n        - `filter_user`\n            \n\n### 2025.03.06\n\n- \\[Listagem das jornadas dos clientes\\] - Rota foi descontinuada `/api/v1/journeys_clients`\n    \n- \\[[Tarefas](https://doc.api.customerx.com.br/?version=latest#601db571-1c31-4f1d-8d4d-9f3680b45c88)\\] - Adiciona parâmetro `added_on_task_at` de data de vinculo de etiqueta na tarefa no retorno das request.\n    \n- \\[[Tarefas da Jornada](https://doc.api.customerx.com.br/?version=latest#c76f8a81-7415-4d13-9ce5-d55da37365f4)\\] - Adicionado parâmetro `added_on_task_at` de data de vinculo de etiqueta na tarefa da jornada no retorno das request.\n    \n\n### 2025.01.14\n\n- \\[[Clientes](https://doc.api.customerx.com.br/?version=latest#88a2b895-968c-4854-9506-1a421278d99b)\\] - Adicionado nova rota Upsert de cliente, como essa rota pode ser criado novos clientes ou atualizados com base no `external_id_client` ou no `id`\n    \n\n### 2024.11.14\n\n- \\[Todos os GET\\] Adicionado em todas as rotas get os parâmetros de buscar por data de criação ou atualização.\n    \n    - Filtro por data de criação:\n        \n        - `filter_between_created_date[date_initial]`\n            \n        - `filter_between_created_date[date_final]`\n            \n    - Filtro por data de atualização:\n        \n        - `filter_between_updated_date[date_initial]`\n            \n        - `filter_between_updated_date[date_final]`\n            \n- \\[Todos os GET\\] Adicionado em todas as rotas get paginação.\n    \n\n### 2024.11.05\n\n- \\[[Cadastro de Contrato](https://doc.api.customerx.com.br/?version=latest#2fc28bcd-97a4-429f-8079-f70e7854031a)\\] Adicionado parâmetro (`:reason_cancellation`) para poder informar um texto com o motivo de cancelamento ao cadastrar um contrato novo cancelado.\n    \n\n### 2024.10.03\n\n- \\[[Busca de Clientes](https://doc.api.customerx.com.br/?version=latest#276f1af5-fadd-4b44-82b5-236af1738c8c)\\] Adicionado descrição dos campos de retorno\n    \n\n### 2024.8.23\n\n- \\[[Campos Personalizado de Clientes](https://doc.api.customerx.com.br/?version=latest#ba238431-6298-491b-b840-548a0bccdb93)\\] - Adicionado nova rota para listagem de campos personalizados por clientes.\n    \n- \\[[Campos Personalizados de Contatos](https://doc.api.customerx.com.br/?version=latest#41393e02-d81b-4644-a6bd-0992bff2ef6f)\\] - Adicionado nova rota para listagem de campos personalizados por Contatos.\n    \n- Indicadores\n    \n    - \\[[MRR](https://doc.api.customerx.com.br/?version=latest#854134c8-f9f1-451e-afd3-de458193abb2)\\] - Adicionado nova rota para listagem de valores de MRR por cliente.\n        \n    - \\[[ARR](https://doc.api.customerx.com.br/?version=latest#50abb6b5-a608-418f-8433-dcf5288dac99)\\] - Adicionado nova rota para listagem de valores de ARR por cliente.\n        \n    - \\[[LTV](https://doc.api.customerx.com.br/?version=latest#eb194009-1636-46d8-9ccc-decaa65db433)\\] - Adicionado nova rota para listagem de valores de LTV por cliente.\n        \n    - \\[[Transacional](https://doc.api.customerx.com.br/?version=latest#dbacd03c-add5-4606-987b-38c02068c7a0)\\] - Adicionado nova rota para listagem de valores de Vendas Transacionais por cliente.\n        \n    - \\[[Upsell](https://doc.api.customerx.com.br/?version=latest#e0f559c0-f782-4fc2-9cbf-c7d8cada7005)\\] - Adicionado nova rota para listagem de valores de Upsell por cliente.\n        \n    - \\[[Downsell](https://doc.api.customerx.com.br/?version=latest#916f77d5-cba7-4e2b-b3cc-75fdb7814ac2)\\] - Adicionado nova rota para listagem de valores de Downsell por cliente.\n        \n    - \\[[Health Score](https://doc.api.customerx.com.br/?version=latest#1fcccc3a-c14c-4da2-bd2e-12b53630955b)\\] - Adicionado nova rota para listagem de valores de Health Score por cliente.\n        \n    - \\[[NPS](https://doc.api.customerx.com.br/?version=latest#600d8f4e-467a-4704-b375-21a5f3c7c290)\\] - Adicionado nova rota para listagem de valores de NPS por cliente.\n        \n    - \\[[CSAT](https://doc.api.customerx.com.br/?version=latest#dc9bd84d-7d19-4100-96ed-24c2af1d648a)\\] - Adicionado nova rota para listagem de valores de CSAT por cliente.\n        \n\n### 2024.6.11\n\n- \\[[Net Promoter Scores](https://doc.api.customerx.com.br/?version=latest#3fa0e2d1-a897-4032-a56b-bdae074a0cf1)\\] - Adicionado novos filtros na busca NPS por código do cliente: `filter_by_external_id_client`, código do contato: `filter_by_external_id_contact`, e-mail do contato: `filter_by_email` e data de resposta entre 2 datas: `filter_by_between_date_response`.\n    \n- \\[[CSAT](https://doc.api.customerx.com.br/?version=latest#a6cfddee-686a-4aee-bf17-fe3df96b968b)\\] - Adicionado novo parâmetro no retorno da busca de resposta: `external_id_contact`.\n    \n- \\[[CSAT](https://doc.api.customerx.com.br/?version=latest#a6cfddee-686a-4aee-bf17-fe3df96b968b)\\] - Adicionado novos filtros na listagem de resposta do CSAT por código do cliente: `filter_by_external_id_client`, código do contato: `filter_by_external_id_contact`, e-mail do contato: `filter_by_email` e data de resposta entre 2 datas: `filter_by_between_date_response`.\n    \n\n### 2024.6.6\n\n- \\[[Venda Transacional](https://doc.api.customerx.com.br/?version=latest#8a6762ec-96d9-4302-a53b-47fb8bf370cf)\\] - Adicionado a possibilidade de cadastrar uma venda transacional cancelada sem informar o ID do motivo do cancelamento (**`reason_cancellation_id`**)**.** Com isso será cadastrado com um motivo padrão com a descrição “Cadastrado com status cancelado!“\n    \n\n### 2024.5.2\n\n- \\[[Venda Transacional](https://doc.api.customerx.com.br/?version=latest#8a6762ec-96d9-4302-a53b-47fb8bf370cf)\\] - Adicionado parâmetro de busca de detalhes de uma venda transacional `external_id`\n    \n\n### 2024.5.1\n\n- \\[[Clientes](https://doc.api.customerx.com.br/?version=latest#276f1af5-fadd-4b44-82b5-236af1738c8c)\\] - Corrigido filtro `date_register` na rota de clientes\n    \n- \\[[Clientes](https://doc.api.customerx.com.br/?version=latest#276f1af5-fadd-4b44-82b5-236af1738c8c)\\] - Adicionado novos filtros de busca de clientes por período **`filter_between_date_register[date_initial]`** e **`filter_between_date_register[date_final]`**\n    \n\n### 2024.5.0\n\n- \\[[Contratos](https://doc.api.customerx.com.br/?version=latest#1d520661-8731-49c8-bd9b-9a22d6859461)\\] - Adicionado novo filtro de data de atualização de contrato **`filter_update_date[date_initial]`** e **`filter_update_date[date_final]`**\n    \n- \\[[Contatos](https://doc.api.customerx.com.br/?version=latest#c6dddf3e-13a3-4d2d-bd0d-81c1bdf1a5c3)\\] - Adicionado novo filtro de data de atualização de contato `by_date_updated_at_between[date_initial]` e `by_date_updated_at_between[date_final]`\n    \n\n### 2024.4.0\n\n- \\[[Tarefas](https://doc.api.customerx.com.br/?version=latest#aae07b23-f390-4040-9df4-7ad0a0ff09bf)\\] - Adicionado novo filtro para buscar tarefas por data de conclusão **`by_date_closure_between[start_date]`** e **`by_date_closure_between[final_date]`**\n    \n- \\[[Tarefas](https://doc.api.customerx.com.br/?version=latest#aae07b23-f390-4040-9df4-7ad0a0ff09bf)\\] - Adicionado novo filtro para buscar tarefas e-mail do usuário da tarefa **`by_user_email`**\n    \n\n---\n\n## Rate Limit\n\n> O limite é contado **por token** (`Authorization`), **não por endpoint** — é compartilhado entre todas as rotas `/api/v1/\\\\\\\\\\\\\\\\\\*`, com janela fixa de **1 minuto**. \n  \n\n### Limites por plano\n\n| Plano | Requisições/min |\n| --- | --- |\n| Startup | `60` |\n| Growth | `120` |\n| Scale / Enterprise | `240` |\n\n> **Atenção:** O limite pode ser sobrescrito por cota individual do cliente. Sempre confirme o valor real via o header `X-RateLimit-Limit` na resposta. \n  \n\n### Headers de Rate Limit\n\nToda resposta da API inclui os seguintes headers:\n\n| Header | Descrição |\n| --- | --- |\n| `X-RateLimit-Limit` | Limite total de requisições permitidas na janela atual |\n| `X-RateLimit-Remaining` | Requisições restantes na janela atual |\n| `X-RateLimit-Reset` | Timestamp epoch (segundos) indicando quando a janela reinicia |\n| `Retry-After` | Segundos a aguardar antes de tentar novamente (presente em respostas `429`) |\n\n### Erro de Rate Limit\n\n| Status | Quando | Headers presentes |\n| --- | --- | --- |\n| `429` | Limite de requisições excedido | `X-RateLimit-Limit`, `X-RateLimit-Remaining` (`0`), `X-RateLimit-Reset`, `Retry-After` |\n\n> **Boas práticas:** Ao receber um `429`, utilize o valor do header `Retry-After` para agendar o retry. Evite tentativa e erro — aguarde o tempo indicado antes de reenviar a requisição. \n  \n\n---\n\n## Validação de Parâmetros de Query\n\nRef: [Documentação oficial](https://doc.api.customerx.com.br/?version=latest)\n\n> ⚠️ **Mudança de comportamento:** Parâmetros de query não reconhecidos em rotas `GET` de listagem agora retornam `422` em vez de `200` silencioso. \n  \n\n### Como funciona\n\nAo enviar um parâmetro de query não reconhecido para qualquer rota de listagem afetada, a API retorna:\n\n``` json\n{ \"message\": \"Parâmetro(s) não reconhecido(s): filter_external_id_client.\" }\n\n ```\n\n> 💡 **Parâmetros sempre permitidos:** `page`, `per_page` e `format` nunca disparam esse erro — são aceitos em todas as rotas. \n  \n\n### Rotas afetadas pela validação dos parâmetros\n\n| Rota | Descrição |\n| --- | --- |\n| `GET /api/v1/clients` | Clientes |\n| `GET /api/v1/contacts` | Contatos |\n| `GET /api/v1/contracts` | Contratos |\n| `GET /api/v1/contract_additives` | Aditivos de Contratos |\n| `GET /api/v1/contract_plans` | Planos de Contratos |\n| `GET /api/v1/net_promoter_scores` | Net Promoter Scores |\n| `GET /api/v1/csat` | CSAT |\n| `GET /api/v1/transactional_sells` | Venda Transacional |\n| `GET /api/v1/financials` | Financeiro |\n| `GET /api/v1/dashboard_tasks` | Dashboard de Tarefas |\n| `GET /api/v1/indicators/mrr` | Indicador MRR |\n| `GET /api/v1/indicators/arr` | Indicador ARR |\n| `GET /api/v1/indicators/ltv` | Indicador LTV |\n| `GET /api/v1/indicators/transactional` | Indicador Transacional |\n| `GET /api/v1/indicators/upsell` | Indicador Upsell |\n| `GET /api/v1/indicators/downsell` | Indicador Downsell |\n| `GET /api/v1/indicators/health_score` | Indicador Health Score |\n| `GET /api/v1/indicators/nps_score` | Indicador NPS Score |\n| `GET /api/v1/indicators/csat_average` | Indicador CSAT Average |\n| `GET /api/v1/indicators/clients_in_churn_risk` | Clientes em risco de cancelamento |\n| `GET /api/v1/tasks` | Tarefas |\n| `GET /api/v1/tasks_follow_ups` | Tarefas da Jornada — Listar |\n| `GET /api/v1/tasks_follow_ups/:filter_task_follow_up/comments` | Tarefas da Jornada — Comentários |\n| `GET /api/v1/clients/journeys_clients` | Jornadas do Cliente |\n| `GET /api/v1/tickets` | Tickets |\n| `GET /api/v1/ticket_activities` | Atividades de Tickets |\n| `GET /api/v1/ticket_reviews` | Avaliações de Tickets |\n| `GET /api/v1/products` | Produtos |\n| `GET /api/v1/default_journeys` | Jornada Modelo |\n| `GET /api/v1/timelines` | Timeline |\n| `GET /api/v1/segments` | Segmentos |\n| `GET /api/v1/portfolios` | Carteira |\n| `GET /api/v1/groups` | Grupos |\n| `GET /api/v1/services` | Serviços |\n| `GET /api/v1/sellers` | Vendedores |\n| `GET /api/v1/tags` | Tags |\n| `GET /api/v1/users` | Usuários |\n| `GET /api/v1/webhooks` | Webhooks |\n| `GET /api/v1/custom_attributes` | Campos Personalizados |\n| `GET /api/v1/client_custom_attributes` | Campos Personalizados de Clientes |\n| `GET /api/v1/contact_custom_attributes` | Campos Personalizados de Contatos |\n| `GET /api/v1/type_contacts` | Tipos de Contatos |\n\n### Códigos de status relacionados\n\n| Status | Quando | Corpo |\n| --- | --- | --- |\n| `401` | `Authorization` ausente ou inválido | — |\n| `422` | ⚠️ Parâmetro de query não reconhecido | `{\"message\": \"Parâmetro(s) não reconhecido(s): .\"}` |\n| `400` | Parâmetro obrigatório da rota ausente | `{\"message\": \"...\"}` |\n| `404` | `external_id` / `id` referenciado não encontrado | `{\"message\": \"...\"}` |\n\n> 💡 **Dica de integração:** Revise os parâmetros de query utilizados nas suas chamadas GET de listagem. Qualquer parâmetro fora dos aceitos pela rota (exceto `page`, `per_page` e `format`) passará a retornar `422`. Consulte a documentação de cada rota para verificar os parâmetros suportados. \n  \n\n### Parâmetros aceitos por rota\n\n> `page` e `per_page` são aceitos em todas as rotas paginadas e estão omitidos abaixo. \n  \n\n#### `GET /api/v1/clients`\n\n| Parâmetro | Parâmetro | Parâmetro |\n| --- | --- | --- |\n| `external_id_client` | `id` | `company_name` |\n| `trading_name` | `cnpj_cpf` | `ie_rg` |\n| `email` | `cep` | `state` |\n| `city` | `street` | `branch_type` |\n| `district` | `number` | `complement` |\n| `contract_status` | `cancellation_date` | `facebook` |\n| `linkedin` | `twitter` | `instagram` |\n| `youtube` | `site` | `parent_client_id` |\n| `parent_company` | `phone` | `country` |\n| `client_service_id` | `client_segment_id` | `client_group_id` |\n| `filter_by_updated_date` | `filter_between_updated_date[...]` | `filter_between_created_date[...]` |\n| `date_register` | `filter_between_date_register[...]` | `filter_external_ids` |\n| `filter_by_email_domain` | `filter_by_site` | `filter_order_clients[...]` |\n| `filter_clients_without_contacts` | `filter_by_mrr[...]` | `filter_by_health_score[...]` |\n| `filter_origins` | `filter_countries` | `tag_description` |\n\n#### `GET /api/v1/contacts`\n\n| Parâmetro | Parâmetro | Parâmetro |\n| --- | --- | --- |\n| `external_id_client` | `cnpj_cpf` | `id` |\n| `name` | `email` | `phone_fix` |\n| `phone_cel` | `occupation` | `birthday` |\n| `is_principal` | `type_contact_id` | `client_id` |\n| `external_id_contact` | `note` | `platform_active_user` |\n| `filter_by_phone` | `filter_by_phone_with_ddi` | `filter_between_updated_date[...]` |\n| `filter_between_created_date[...]` |  |  |\n\n#### `GET /api/v1/contracts`\n\n| Parâmetro | Parâmetro | Parâmetro |\n| --- | --- | --- |\n| `external_id_client` | `external_id_contract_plan` | `external_id_seller` |\n| `id` | `client_id` | `external_id_contract` |\n| `number_of_users` | `description` | `start_date` |\n| `final_date` | `reason_cancellation_id` | `contract_value` |\n| `value_per_user` | `contract_plan_id` | `initial_value` |\n| `auto_renovation` | `renew_in_days` | `cancellation_reason` |\n| `seller_id` | `date_sale` | `create_renovation_additive` |\n| `cancellation_date` | `filter_between_updated_date[...]` | `filter_between_created_date[...]` |\n| `filter_status` |  |  |\n\n#### `GET /api/v1/contract_additives`\n\n| Parâmetro | Parâmetro | Parâmetro |\n| --- | --- | --- |\n| `id` | `external_id_additive` | `type_additive` |\n| `description` | `date_sale` | `date_initial` |\n| `date_final` | `value_contract` | `value_additive` |\n| `new_value_contract` | `client_id` | `client_contract_id` |\n| `auto_renovation` | `renew_in_days` | `note` |\n| `number_of_users` | `value_per_user` | `contract_plan_id` |\n| `filter_between_updated_date[...]` | `filter_between_created_date[...]` |  |\n\n#### `GET /api/v1/contract_plans`\n\n| Parâmetro | Parâmetro | Parâmetro |\n| --- | --- | --- |\n| `description` | `number_users` | `status` |\n| `external_id` | `filter_between_updated_date[...]` | `filter_between_created_date[...]` |\n\n#### `GET /api/v1/net_promoter_scores`\n\n| Parâmetro | Parâmetro | Parâmetro |\n| --- | --- | --- |\n| `id` | `question` | `response` |\n| `note` | `date_send` | `date_response` |\n| `user` | `contact_id` | `client_id` |\n| `filter_by_external_id_client` | `filter_by_external_id_contact` | `filter_by_email` |\n| `filter_by_between_date_response[...]` | `filter_between_updated_date[...]` | `filter_between_created_date[...]` |\n\n#### `GET /api/v1/csat`\n\n> ⚠️ Esta rota não aceita parâmetros de filtro diretos. Utiliza apenas filtros de escopo (`has_scope`) já documentados: `search`, `by_batch_labels`, `by_client_custom_attributes`, `csat_batch_order`, entre outros. \n  \n\n#### `GET /api/v1/transactional_sells`\n\n| Parâmetro | Parâmetro | Parâmetro |\n| --- | --- | --- |\n| `external_id_client` | `id` | `client_id` |\n| `external_id` | `description` | `sell_date` |\n| `total_value` | `cancellation_date` | `reason_cancellation_id` |\n| `filter_currency` | `filter_portfolio` | `filter_segment` |\n| `filter_city` | `filter_group` | `filter_tag` |\n| `filter_product` | `filter_with_product` | `filter_without_product` |\n| `filter_with_subproduct` | `filter_without_subproduct` | `filter_by_contains_contract_plans` |\n| `filter_by_exact_contract_plans` | `filter_by_not_contains_contract_plans` | `filter_by_not_exact_contract_plans` |\n| `filter_by_ids` | `by_current_user_portfolio` | `by_sell_date_month` |\n| `filter_client_custom_attributes[...]` | `filter_between_updated_date[...]` | `filter_between_created_date[...]` |\n\n#### `GET /api/v1/financials`\n\n| Parâmetro | Parâmetro | Parâmetro |\n| --- | --- | --- |\n| `external_id_client` | `identifier` | `date_issue` |\n| `date_due` | `date_payment` | `value` |\n| `date_original_due` | `discount_value` | `amount_paid` |\n| `status` | `client_id` | `external_id_financial` |\n| `document_url` | `filter_client` | `filter_identifier` |\n| `filter_status` | `by_overdue` | `to_overdue` |\n| `filter_date_issue[...]` | `filter_date_due[...]` | `filter_date_payment[...]` |\n| `filter_countries` | `filter_state` | `filter_client_service` |\n| `by_client_date_register[...]` | `filter_statuses` | `filter_between_updated_date[...]` |\n| `filter_between_created_date[...]` |  |  |\n\n#### `GET /api/v1/dashboard_tasks`\n\n| Parâmetro | Parâmetro | Parâmetro |\n| --- | --- | --- |\n| `user_id` | `filed` | `filter_between_created_date[...]` |\n| `filter_between_updated_date[...]` |  |  |\n\n#### `GET /api/v1/indicators/{mrr,arr,ltv,transactional,upsell,downsell}`\n\n> 💡 `client_id` **ou** `external_id_client` é obrigatório em todas essas rotas. \n  \n\n| Parâmetro | Obrigatório | Observação |\n| --- | --- | --- |\n| `client_id` | Sim (ou `external_id_client`) | Identificador interno do cliente |\n| `external_id_client` | Sim (ou `client_id`) | Identificador externo do cliente |\n| `filter_by_client_id` | Não | — |\n| `filter_by_external_id_client` | Não | — |\n| `filter_by_created_up_to` | Não | Calculado automaticamente pela API |\n\n#### `GET /api/v1/indicators/{health_score,nps_score,csat_average}`\n\n> 💡 `client_id` **ou** `external_id_client` é obrigatório em todas essas rotas. \n  \n\n| Parâmetro | Obrigatório | Observação |\n| --- | --- | --- |\n| `client_id` | Sim (ou `external_id_client`) | Identificador interno do cliente |\n| `external_id_client` | Sim (ou `client_id`) | Identificador externo do cliente |\n| `filter_by_month` | Não | Mês de referência |\n| `filter_by_year` | Não | Ano de referência |\n\n#### `GET /api/v1/indicators/clients_in_churn_risk`\n\n| Parâmetro | Obrigatório | Observação |\n| --- | --- | --- |\n| `client_id` | Não | Identificador interno do cliente |\n| `external_id_client` | Não | Identificador externo do cliente |\n| `status` | Não | — |\n| `initial_date` | Não | ⚠️ Deve ser enviado junto com `final_date` |\n| `final_date` | Não | ⚠️ Deve ser enviado junto com `initial_date` |\n\n#### `GET /api/v1/tasks`\n\n| Parâmetro | Parâmetro | Parâmetro |\n| --- | --- | --- |\n| `filter_order[...]` | `filter_between_date_closure[...]` | `filter_between_date_scheduled[...]` |\n| `filter_user` | `title` | `by_client` |\n| `by_status` | `by_user_id` | `by_date_scheduled_present` |\n| `by_date_scheduled_between[...]` | `by_date_closure_between[...]` | `by_date_updated_at_between[...]` |\n| `by_user_email` | `by_labels` | `by_only_filed` |\n| `by_only_not_filed` | `by_dashboard_activities_step_id` | `order_by_position` |\n| `order_by_date_scheduled_asc` | `order_by_date_scheduled_desc` | `by_client_tag` |\n| `by_task_label` | `filter_between_updated_date[...]` | `filter_between_created_date[...]` |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"3927575","team":166891,"collectionId":"a2d563ef-e168-4673-b271-c8b9e777cd87","publishedId":"2s935poNcv","public":true,"publicUrl":"https://doc.api.customerx.com.br","privateUrl":"https://go.postman.co/documentation/3927575-a2d563ef-e168-4673-b271-c8b9e777cd87","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"800185"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.12.4","publishDate":"2023-02-06T17:18:43.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Api Sandbox","id":"babbd4c3-8838-4523-9bc8-8fd204c9b4bb","owner":"3927575","values":[{"key":"url","value":"https://sandbox.api.customerx.com.br","enabled":true},{"key":"authorization","value":"SEU_API_TOKEN","enabled":true},{"key":"access-token","value":"","enabled":true},{"key":"client","value":"","enabled":true},{"key":"uid","value":"","enabled":true}],"published":true}],"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/a45cbbe1465c92623fe74fbe4bae27b7d64fa40fa5d337e7bf1e27e5678c9c05","favicon":"https://res.cloudinary.com/postman/image/upload/v1542660099/team/cnqsfqua5qsfgt298qau.ico"},"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"},{"label":"Api Sandbox","value":"3927575-babbd4c3-8838-4523-9bc8-8fd204c9b4bb"}],"canonicalUrl":"https://doc.api.customerx.com.br/view/metadata/2s935poNcv"}