Skip to main content
POST
/
v2
/
inbound
/
contacts
/
search
Search contacts
curl --request POST \
  --url https://enrich.octolane.com/v2/inbound/contacts/search \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "query": "<string>",
  "filters": [
    {}
  ],
  "sort": {},
  "cursor": "<string>",
  "limit": 123,
  "fields": [
    "<string>"
  ]
}
'
Advanced search endpoint for Contacts. Supports filters on system and custom fields, sorting, cursor pagination, and field selection.

Request

X-API-Key
string
required
Your Octolane API key.
Content-Type
string
required
Must be application/json.

Body parameters

query
string
Basic text search across name and email. Alias: q.
filters
array
Array of filter objects. See Filters.
sort
string | object | array
Sort configuration. Default: updated_at desc.
cursor
string
Opaque cursor from a previous response.
limit
number
default:"100"
Page size. Max 500.
fields
string[]
Fields to return.

Example request

curl -X POST "https://enrich.octolane.com/v2/inbound/contacts/search" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 10,
    "q": "john",
    "filters": [
      { "field": "email", "operator": "contains", "value": "@example.com" },
      { "field": "customer_tier", "operator": "eq", "value": "enterprise" }
    ],
    "sort": { "field": "updated_at", "direction": "desc" },
    "fields": ["id", "name", "email", "job_title", "custom_fields"]
  }'

Supported sort fields

updated_at, created_at, name, first_name, last_name, email, account_id, id

Response

Identical shape to GET /contacts.