Listar pessoas no Agendor, por uma API
Lista e busca as pessoas da conta, 10 por página por padrão, em data, com meta.totalCount e a próxima página em links.next.
- Identificador
- agendor_list_people
A chamada
POST https://connect.reportei.com/api/tools/agendor_list_people/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"name": "<name>"
}
}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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| name | string | Não | Beginning of the name. |
| string | Não | Beginning of the email address. | |
| cpf | string | Não | Beginning of the CPF. |
| phone | string | Não | Number searched in every phone field. |
| organization | integer | Não | Id of an organization, from List organizations, to return its people. |
| userOwner | integer | Não | Id of the user who owns the people, from List users. |
| state | string | Não | State abbreviation of the address.Valores: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO |
| createdAtGt | string | Não | Returns people created after this date and time, in ISO 8601. |
| updatedAtGt | string | Não | Returns people updated after this date and time, in ISO 8601. |
| withCustomFields | boolean | Não | true includes the custom fields of each person. |
| page | integer | Não | Page number, starting at 1. |
| per_page | integer | Não | People per page, up to 100. The default is 10. |
Conexões possíveis
O seu cliente conecta a conta do Agendor 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.
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/agendor_list_people. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Agendor
- Criar pessoaPOSTCria uma pessoa, contato de uma organização no B2B ou o cliente no B2C, e a devolve em data. name é obrigatório.
- Atualizar pessoaPUTAtualiza os campos enviados e devolve a pessoa em data. Os campos omitidos mantêm o valor.
- Listar organizaçõesGETLista e busca as organizações da conta, os clientes B2B, 10 por página por padrão, em data, com meta.totalCount e a próxima página em links.next.
- Criar organizaçãoPOSTCria uma organização, um cliente B2B, e a devolve em data. name é obrigatório.
- Atualizar organizaçãoPUTAtualiza os campos enviados e devolve a organização em data. Os campos omitidos mantêm o valor.
- Listar negóciosGETLista e busca os negócios da conta, 10 por página por padrão, em data, com meta.totalCount e a próxima página em links.next. Cada negócio traz seu status e mais.
- Criar negócio de organizaçãoPOSTCria um negócio para uma organização, o caso B2B, e o devolve em data. title é obrigatório. Sem funnel e dealStage, o negócio começa na primeira etapa do funil padrão.
- Criar negócio de pessoaPOSTCria um negócio para uma pessoa, o caso B2C, e o devolve em data. title é obrigatório. Sem funnel e dealStage, o negócio começa na primeira etapa do funil padrão.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
