Listar objetos no folk, por uma API

Lista os negócios, ou os objetos de outro tipo, de um grupo, com id, nome, pessoas e empresas vinculadas e valores dos campos personalizados, como o Status do negócio. A próxima página vem do cursor dentro de pagination.nextLink; a última página não tem nextLink. Um objectType desconhecido responde 404 com os tipos de objeto do grupo.

Identificador
folk_list_objects

A chamada

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "groupId": "<groupId>",
    "objectType": "<objectType>"
  }
}

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
groupIdstringSimId of the group, starting with grp_, from List groups.
objectTypestringSimName of the object type exactly as shown in folk, case-sensitive and with its spaces: Deals for deals, or another objectField name from List group custom fields.
limitintegerNãoResults per page, up to 100. Defaults to 20.
cursorstringNãoThe cursor value inside pagination.nextLink of the previous response, URL-decoded (%3D becomes =). Omit it on the first call.

Conexões possíveis

O seu cliente conecta a conta do folk 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/folk_list_objects. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do folk

Ver as 13 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.