Listar organizaciones en Agendor, con una API

Lista y busca las organizaciones de la cuenta, los clientes B2B, 10 por página por defecto, en data, con meta.totalCount y la página siguiente en links.next.

Identificador
agendor_list_organizations

La llamada

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>"
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
namestringNoBeginning of the trade name.
nameExactstringNoWhole trade name, matched exactly.
cnpjstringNoBeginning of the CNPJ.
emailstringNoBeginning of the email address.
phonestringNoNumber searched in every phone field.
userOwnerintegerNoId of the user who owns the organizations, from List users.
statestringNoState 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
createdAtGtstringNoReturns organizations created after this date and time, in ISO 8601.
updatedAtGtstringNoReturns organizations updated after this date and time, in ISO 8601.
withCustomFieldsbooleanNotrue includes the custom fields of each organization.
pageintegerNoPage number, starting at 1.
per_pageintegerNoOrganizations per page, up to 100. The default is 10.

Conexiones posibles

Tu cliente conecta su cuenta de Agendor una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

Clave de API

Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/agendor_list_organizations. Se convierte en la definición de tool de tu agente sin conversión.

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.