Listar parties no Capsule CRM, por uma API

Lista as pessoas e organizações da conta, 50 por página por padrão. Pagine com page, começando em 1, e perPage, até 100; uma página menor que perPage é a última.

Identificador
capsule_list_parties

A chamada

POST https://connect.reportei.com/api/tools/capsule_list_parties/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "since": "<since>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
sincestringNãoOnly parties changed after this moment, in ISO 8601.
pageintegerNãoPage to return, starting at 1.
perPageintegerNãoParties per page, up to 100. The default is 50.
embedstringNãoComma-separated extra data to include: tags, fields, organisation or missingImportantFields. Custom fields only come back with fields.

Conexões possíveis

O seu cliente conecta a conta do Capsule CRM uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/capsule, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/capsule_list_parties. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Capsule CRM

Ver as 15 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.