API ReferenceCustomization

List Custom Objects

Lists custom objects.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

leaf_typestringRequiredformat: "text"
Leaf type to filter.
cursorstringOptionalformat: "text"
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
filterlist of anyOptional
List of filters to apply.
filterslist of anyOptional
List of filters to apply.
limitintegerOptional
The maximum number of items.
modeenumOptional
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values:
sort_bylist of stringsOptional
The list of fields to sort the items by and how to sort them.

Response

The response to listing all custom objects matching the filter criteria.
resultlist of objects
The custom objects.
next_cursorstring or nullformat: "text"
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursorstring or nullformat: "text"
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors