Custom Objects List Post

POST

Lists custom objects.

Request

This endpoint expects an object.
leaf_typestringRequired

Leaf type to filter.

cursorstringOptional

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

filterlist of anyOptional

List of filters to apply.

limitintegerOptional

The maximum number of items.

mode"after" or "before"Optional
Allowed values: afterbefore

The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

sort_bylist of stringsOptional

The list of fields to sort the items by and how to sort them.

Response

This endpoint returns an object.
resultlist of objects

The custom objects.

next_cursorstringOptional

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptional

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.