GET /api/v2/custom_objects/{custom_object_key}/records

Lists all undeleted custom object records for the specified object

Pagination

Cursor pagination only.

Allowed For

Agents

Servers

https://{subdomain}.{domain}.com

Path parameters

Name	Type	Required	Description
`custom_object_key`	String	Yes	The key of a custom object

Query parameters

Name	Type	Required	Description
`filterids`	String	No	Optional comma-separated list of ids to filter records by. If one or more ids are specified, only matching records are returned. The ids must be unique and are case sensitive.
`filterexternal_ids`	String	No	Optional comma-separated list of external ids to filter records by. If one or more ids are specified, only matching records are returned. The ids must be unique and are case sensitive.
`sort`	String	No	One of `id`, `updated_at`, `-id`, or `-updated_at`. The `-` denotes the sort will be descending.
`pageafter`	String	No	A pagination cursor that tells the endpoint which page to start on. It should be a `meta.after_cursor` value from a previous request. Note: `page[before]` and `page[after]` can't be used together in the same request.
`pagebefore`	String	No	A pagination cursor that tells the endpoint which page to start on. It should be a `meta.before_cursor` value from a previous request. Note: `page[before]` and `page[after]` can't be used together in the same request.
`pagesize`	Integer	No	Specifies how many records should be returned in the response. You can specify up to 100 records per page.

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.