Bulk read changes API
You can get an array of contact IDs of all contacts that have been changed (created, updated or deleted) within a specified time window using this endpoint:
GET /api/v2/contacts/changes
Request
This endpoint takes three parameters:
Parameter | Type | Example value |
|---|---|---|
*changeType | String | Created, Updated, Deleted |
*fromDate | DateTime | The start date and time of the search window. |
toDate | DateTime | The end date and time of the search window. |
Items marked with * are mandatory.
If toDate is left out of the query, the current date and time will be used.
For example, assuming the date and time now is "2023-05-04 11:20:00.000" and you want the IDs of all contacts created over the last 15 minutes, the request would then be:
GET /api/v2/contacts/changes?changeType=Created&fromDate=2023-05-04%2011%3A05%3A00.000
Response
The response will look like this:
[ "b16fd8f3-d0f5-aaaa-aa60-b00300f9aaaa", "febb6003-863d-bbbb-a4d0-b0030119bbbb" ]
Or, if there are no contacts matching your search, an empty array:
[]
Restrictions
The number of contactIds that can be returned in the response is currently capped at 250 000. If your query creates a response that exceeds this limit, it will instead return a Bad Request status code.