Listar campos personalizados do grupo no folk, por uma API
Lista os campos personalizados de um grupo para pessoas, empresas ou um tipo de objeto, com nome, tipo e as opções dos campos de seleção. Em pessoa ou empresa, cada campo do tipo objectField é um tipo de objeto do grupo, como Deals, e seu nome é o objectType das tools de objeto.
- Identificador
- folk_list_group_custom_fields
A chamada
POST https://connect.reportei.com/api/tools/folk_list_group_custom_fields/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"groupId": "<groupId>",
"entityType": "<entityType>"
}
}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 |
|---|---|---|---|
| groupId | string | Sim | Id of the group, starting with grp_, from List groups. |
| entityType | string | Sim | person, company, or the name of an object type of the group, like Deals. Case-sensitive. |
| limit | integer | Não | Results per page, up to 100. Defaults to 20. |
| cursor | string | Não | The 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_group_custom_fields. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do folk
- Listar gruposGETLista os grupos do workspace com id e nome. Os grupos contêm pessoas, empresas e negócios. A próxima página vem do cursor dentro de pagination.nextLink; a última página não tem nextLink.
- Listar pessoasGETLista as pessoas do workspace com id, nomes, e-mails, telefones, cargo, empresas, grupos e valores dos campos personalizados. A próxima página vem do cursor dentro de pagination.nextLink; a última página não tem nextLink.
- Criar pessoaPOSTCria uma pessoa, opcionalmente em grupos e vinculada a empresas. O folk mescla duplicatas em segundo plano, o que pode sobrescrever parte dos dados enviados. Uma pessoa sem grupo só aparece na busca do folk.
- Atualizar pessoaPATCHAtualiza uma pessoa, alterando apenas os campos enviados. Uma lista (groups, companies, emails, phones, addresses, urls) substitui a atual, então envie-a completa. Deixar um grupo de fora remove a pessoa dele, junto com os valores dos campos personalizados nesse grupo.
- Listar empresasGETLista as empresas do workspace com id, nome, setor, e-mails, telefones, URLs, grupos e valores dos campos personalizados. A próxima página vem do cursor dentro de pagination.nextLink; a última página não tem nextLink.
- Criar empresaPOSTCria uma empresa, opcionalmente em grupos. Os nomes são únicos no workspace: um nome existente devolve essa empresa em vez de criar outra. Uma empresa sem grupo só aparece na busca do folk.
- Atualizar empresaPATCHAtualiza uma empresa, alterando apenas os campos enviados. Uma lista (groups, emails, phones, addresses, urls) substitui a atual, então envie-a completa. Deixar um grupo de fora remove a empresa dele, junto com os valores dos campos personalizados nesse grupo. Um nome já usado por outra empresa falha.
- Listar objetosGETLista 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.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
