Listar empresas en folk, con una API
Lista las empresas del workspace con id, nombre, sector, emails, teléfonos, URLs, grupos y valores de los campos personalizados. La página siguiente viene del cursor dentro de pagination.nextLink; la última página no tiene nextLink.
- Identificador
- folk_list_companies
La llamada
POST https://connect.reportei.com/api/tools/folk_list_companies/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"limit": 1
}
}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ámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| limit | integer | No | Results per page, up to 100. Defaults to 20. |
| cursor | string | No | The cursor value inside pagination.nextLink of the previous response, URL-decoded (%3D becomes =). Omit it on the first call. |
Conexiones posibles
Tu cliente conecta su cuenta de folk 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/folk_list_companies. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de folk
- Listar gruposGETLista los grupos del workspace con id y nombre. Los grupos contienen personas, empresas y negocios. La página siguiente viene del cursor dentro de pagination.nextLink; la última página no tiene nextLink.
- Listar campos personalizados del grupoGETLista los campos personalizados de un grupo para personas, empresas o un tipo de objeto, con nombre, tipo y las opciones de los campos de selección. En persona o empresa, cada campo de tipo objectField es un tipo de objeto del grupo, como Deals, y su nombre es el objectType de las tools de objeto.
- Listar personasGETLista las personas del workspace con id, nombres, emails, teléfonos, cargo, empresas, grupos y valores de los campos personalizados. La página siguiente viene del cursor dentro de pagination.nextLink; la última página no tiene nextLink.
- Crear personaPOSTCrea una persona, opcionalmente en grupos y vinculada a empresas. folk fusiona duplicados en segundo plano, lo que puede sobrescribir parte de los datos enviados. Una persona sin grupo solo aparece en la búsqueda de folk.
- Actualizar personaPATCHActualiza una persona, cambiando solo los campos enviados. Una lista (groups, companies, emails, phones, addresses, urls) sustituye a la actual, así que envíala completa. Dejar un grupo fuera quita a la persona de él, junto con los valores de sus campos personalizados en ese grupo.
- Crear empresaPOSTCrea una empresa, opcionalmente en grupos. Los nombres son únicos en el workspace: un nombre existente devuelve esa empresa en lugar de crear otra. Una empresa sin grupo solo aparece en la búsqueda de folk.
- Actualizar empresaPATCHActualiza una empresa, cambiando solo los campos enviados. Una lista (groups, emails, phones, addresses, urls) sustituye a la actual, así que envíala completa. Dejar un grupo fuera quita a la empresa de él, junto con los valores de sus campos personalizados en ese grupo. Un nombre ya usado por otra empresa falla.
- Listar objetosGETLista los negocios, o los objetos de otro tipo, de un grupo, con id, nombre, personas y empresas vinculadas y valores de los campos personalizados, como el Status del negocio. La página siguiente viene del cursor dentro de pagination.nextLink; la última página no tiene nextLink. Un objectType desconocido responde 404 con los tipos de objeto del grupo.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
