Listar contactos en Omnisend, con una API

Lista los contactos con id, email, phone, status, tags, segments y propiedades personalizadas, del más nuevo al más antiguo por defecto. La respuesta tiene contacts y paging; mientras paging.hasMore sea true, pasa paging.cursors.after como after y mantén los filtros.

Identificador
omnisend_list_contacts

La llamada

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>"
  }
}

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ámetroTipoObligatorioDescripción
emailstringNoOnly the contact with this email address.
phonestringNoOnly the contact with this phone number, in E.164 format such as +5511999998888.
statusstringNoOnly the contacts with this email subscription status. Does not work together with tag.Valores: subscribed, unsubscribed, nonSubscribed
tagstringNoOnly the contacts with this tag. Does not work together with status.
segmentIDstringNoOnly the contacts of this segment, by the segmentID from List segments.
updatedAtFromstringNoOnly the contacts updated at or after this RFC 3339 date-time. Does not work together with the other filters.
sortstringNoField to sort by. The default is createdAt.Valores: createdAt, updatedAt
directionstringNoOrder of the sort, used only with sort. The default is desc.Valores: asc, desc
limitintegerNoContacts per page, up to 250. The default is 100.
afterstringNoThe paging.cursors.after of the previous page.

Conexiones posibles

Tu cliente conecta su cuenta de Omnisend 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/omnisend_list_contacts. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Omnisend

Ver las 14 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.