customization

Custom States List Post

POST
Lists custom states.

Request

This endpoint expects an object.
cursor
stringOptional
The cursor to resume iteration from, otherwise if not provided, then iteration starts from the beginning.
is_final
booleanOptional
Whether only final states should be filtered.
limit
integerOptional
The maximum number of items.
name
list of stringsOptional
The list of state names.
ordinal
list of integersOptional
The list of state ordinals.
sort_by
list of stringsOptional
The list of fields to sort the items by and how to sort them.

Response

This endpoint returns an object
result
list of objects
The custom states.
cursor
stringOptional
The cursor to resume iteration from, otherwise if not provided, then iteration starts from the beginning.