customization

Custom States List

GET
Lists custom states.

Query parameters

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.
namestringOptional
The list of state names.
ordinalintegerOptional
The list of state ordinals.
sort_bystringOptional
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.
GET
1curl https://api.devrev.ai/states.custom.list \
2 -H "Authorization: <apiKey>"
200Retrieved
1{
2 "result": [
3 {
4 "id": "id",
5 "created_date": "2023-01-01T12:00:00Z",
6 "display_id": "display_id",
7 "modified_date": "2023-01-01T12:00:00Z"
8 }
9 ],
10 "cursor": "cursor"
11}