GET /api/v2/incremental/custom_objects/{custom_object_key}/cursor
Returns the custom object records that changed since the start time. This endpoint supports cursor-based incremental exports for custom object records.
This endpoint only supports cursor-based pagination and does not support offset-based pagination. Cursor-based exports provide more consistent performance and response body sizes. For more information, see Cursor-based incremental exports in Using the Incremental Exports API.
Allowed For
- Admins
- Agents with custom object read permissions
Rate Limiting
You can make up to 10 requests per minute to this endpoint.
Notes
start_timeis only required for the initial request for the pages in the record set, thencursoris required for all subsequent requests- The
start_timemust be more than 60 seconds ago - Deleted records will have their field values replaced with "[DELETED]" unless excluded via filter
- Photo fields are excluded from incremental export responses
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
custom_object_key |
String | Yes |
The key identifier for the custom object |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
start_time |
Integer | Yes |
The time to start the incremental export from. Must be at least one minute in the past. Data isn't provided for the most recent minute |
per_page |
Integer | No |
Number of records to return per page (default 1000, maximum 1000) Default value: 1000 |
filter[exclude_deleted] |
Boolean | No |
If true, exclude deleted records from the export Default value: false |
cursor |
String | No |
The cursor pointer to work with for all subsequent exports after the initial request |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.