COconversion

Export Contacts

Bulk, incremental export of contacts, ordered by updatedAt ascending. Each contact's fields are flattened under fields, keyed by their label.

Results are paginated with an opaque cursor returned as pagination.nextCursor. Pass it back as cursor to fetch the next page; a null cursor means there are no more results. Persist the last non-null cursor between syncs to resume. Passing the stored cursor on a later call yields contacts created or updated since.

Request access. This endpoint is not enabled by default, contact the Conversion team to request access. Calls from accounts without it return 403 export_not_enabled.

post/v2/exports/contacts

Request

  • Base URL
    https://pub-api.conversion.ai/api
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key

Request body

cursorstring

The opaque pagination cursor returned as pagination.nextCursor by a previous call. Omit (or pass an empty string) on the first call to start from the beginning. An invalid or malformed cursor returns an invalid_cursor error.

limitinteger

The maximum number of contacts to return per page. Defaults to 1000. Values are clamped to the range [1, 5000] rather than rejected; values above 5000 return 5000 results.

Example request

{
  "cursor": "eyJjcmVhdGVkQXQiOiIyMDI2LTAxLTE1VDEwOjMwOjAwWiJ9"
}

Response

A page of contacts retrieved successfully.

Example response

{
  "data": {
    "contacts": [
      {
        "subscriptionStatus": "SUBSCRIBED"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.