Cortex icon

Cortex

Interact with Cortex API

Contact → List

AI-generated

Summary

List contacts from the Cortex system applying optional search and filters. Return paginated contact data based on criteria such as name, phone, email, tag, and source.

Inputs

  • Search — Optional search string to filter contacts by name, phone, or email.
  • Filter by Tag — Optional tag to filter contacts by a specific tag.
  • Filter by Source — Optional source identifier to filter contacts by their source.
  • Limit — Maximum number of contacts to retrieve; must be between 1 and 100, defaults to 50.
  • Offset — Pagination offset to skip a number of contacts, defaults to 0.

Output shape

a JSON array of contacts, each representing a contact object with potentially varied fields according to the Cortex API response

The operation performs an HTTP GET request to the Cortex contacts endpoint with query parameters for filtering and pagination. The response is returned directly; if an error occurs and 'Continue on Fail' is enabled, an error message is included in the output JSON.

Examples

Example 1: Retrieve up to 20 contacts with the tag 'vip' and source 'crm', searching for 'John'

Set Search to 'John', Filter by Tag to 'vip', Filter by Source to 'crm', Limit to 20, Offset to 0.

Links

Discussion