Listar contatos no Omnisend, por uma API

Lista os contatos com id, email, phone, status, tags, segments e propriedades customizadas, do mais novo para o mais antigo por padrão. A resposta tem contacts e paging; enquanto paging.hasMore for true, passe paging.cursors.after como after e mantenha os filtros.

Identificador
omnisend_list_contacts

A chamada

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

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

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
emailstringNãoOnly the contact with this email address.
phonestringNãoOnly the contact with this phone number, in E.164 format such as +5511999998888.
statusstringNãoOnly the contacts with this email subscription status. Does not work together with tag.Valores: subscribed, unsubscribed, nonSubscribed
tagstringNãoOnly the contacts with this tag. Does not work together with status.
segmentIDstringNãoOnly the contacts of this segment, by the segmentID from List segments.
updatedAtFromstringNãoOnly the contacts updated at or after this RFC 3339 date-time. Does not work together with the other filters.
sortstringNãoField to sort by. The default is createdAt.Valores: createdAt, updatedAt
directionstringNãoOrder of the sort, used only with sort. The default is desc.Valores: asc, desc
limitintegerNãoContacts per page, up to 250. The default is 100.
afterstringNãoThe paging.cursors.after of the previous page.

Conexões possíveis

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

Outras tools do Omnisend

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