Listar organizações no Agendor, por uma API

Lista 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.

Identificador
agendor_list_organizations

A chamada

POST https://connect.reportei.com/api/tools/agendor_list_organizations/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âmetroTipoObrigatórioDescrição
namestringNãoBeginning of the trade name.
nameExactstringNãoWhole trade name, matched exactly.
cnpjstringNãoBeginning of the CNPJ.
emailstringNãoBeginning of the email address.
phonestringNãoNumber searched in every phone field.
userOwnerintegerNãoId of the user who owns the organizations, from List users.
statestringNãoState 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
createdAtGtstringNãoReturns organizations created after this date and time, in ISO 8601.
updatedAtGtstringNãoReturns organizations updated after this date and time, in ISO 8601.
withCustomFieldsbooleanNãotrue includes the custom fields of each organization.
pageintegerNãoPage number, starting at 1.
per_pageintegerNãoOrganizations 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_organizations. Ele vira a definição de tool do seu agente sem conversão.

Veja o Connect aplicado ao seu produto.

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