Skip to main content
POST

Authorizations

X-API-Key
string
header
required

Your Conversion API key. Found in Settings > Integrations in the dashboard. Format: sk_live_<key_id>_<secret>.

Body

application/json
cursor
string

The opaque pagination cursor returned as pagination.nextCursor by a previous call to this endpoint or to Export Contacts. Omit (or pass an empty string) on the first call to start from the beginning: every live contact, then every deleted contact Conversion still keeps. An invalid or malformed cursor returns an invalid_cursor error.

Example:

"c1.eyJjb250YWN0cyI6ImV5SmpjbVZoZEdWa1FYUWlPaUl5TURJMkxUQXhMVEUxVkRFd09qTXdPakF3V2lKOSIsImRlbGV0aW9ucyI6eyJ1cGRhdGVkQXQiOiIyMDI2LTA1LTMxVDEyOjAwOjAwWiIsInJlY29yZElkIjoiYjJjM2Q0ZTUtZjZhNy04OTAxLWJjZGUtZjIzNDU2Nzg5MDEyIn19"

limit
integer
default:1000

The maximum number of live contacts per page. A page also carries up to this many (at most 1000) deleted or restored contacts. Defaults to 1000. Values are clamped to the range [1, 5000] rather than rejected; values above 5000 return 5000 results.

Required range: 1 <= x <= 5000

Response

A page of contacts retrieved successfully.

data
object
pagination
object