API ReferenceCustomization

List States Custom (POST)

Lists custom states.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
cursorstringOptionalformat: "text"
The cursor to resume iteration from, otherwise if not provided, then iteration starts from the beginning.
is_finalbooleanOptional
Whether only final states should be filtered.
limitintegerOptional
The maximum number of items.
namelist of stringsOptional
The list of state names.
ordinallist of integersOptional
The list of state ordinals.
sort_bylist of stringsOptional
The list of fields to sort the items by and how to sort them.

Response

Success.
resultlist of objects
The custom states.
cursorstring or nullformat: "text"
The cursor to resume iteration from, otherwise if not provided, then iteration starts from the beginning.

Errors