List contacts with the Omnisend API

Lists the contacts with their id, email, phone, status, tags, segments and custom properties, newest first by default. The response has contacts and paging; while paging.hasMore is true, pass paging.cursors.after as after and keep the filters.

Identifier
omnisend_list_contacts

The request

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

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
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.Values: 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.Values: createdAt, updatedAt
directionstringNoOrder of the sort, used only with sort. The default is desc.Values: asc, desc
limitintegerNoContacts per page, up to 250. The default is 100.
afterstringNoThe paging.cursors.after of the previous page.

Supported connections

Your customer connects their Omnisend account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/omnisend_list_contacts. It becomes your agent's tool definition with no conversion.

Other Omnisend tools

See all 14 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.