Custom States List Post

POST

Lists custom states.

Request

This endpoint expects an object.
cursorstringOptional

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

This endpoint returns an object.
resultlist of objects

The custom states.

cursorstringOptional

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