Listar contatos no Keap, por uma API

Lista os contatos do app Keap em contacts, com next_page_token para a página seguinte. Sem fields, cada contato vem com um conjunto padrão de propriedades. Filtre por email, nome, ids e outros campos com filter.

Identificador
keap_list_contacts

A chamada

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "filter": "<filter>"
  }
}

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
filterstringNãoFilters joined by ;, each one field==value, for example email==ana@acme.com or given_name==Mar* for a prefix. Fields: email, given_name, family_name, ids (comma-separated, from List contacts), city, state, website, start_update_time and end_update_time (ISO 8601 with milliseconds), plus custom fields by field name.
fieldsstringNãoComma-separated properties to return, for example email_addresses,phone_numbers,tag_ids,owner_id,custom_fields,create_time.
order_bystringNãoField and direction separated by a space: id, create_time, email or update_time, then asc or desc, for example create_time desc.
page_sizeintegerNãoContacts per page, up to 1000.
page_tokenstringNãoThe next_page_token of the previous response. Omit it on the first page.

Conexões possíveis

O seu cliente conecta a conta do Keap uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/keap, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

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/keap_list_contacts. 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.