Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Cases

Get a list of available case states

This endpoint returns all possible states to which a case can be transitioned.

get/v2/cases/states

Query parameters

page_numberinteger

One-based page index (1..N)

page_sizeinteger

The size of the page to be returned

sortstring[]

Sorting criteria in the format of: [-]property (- descending modifier).

  • Default sort order is ascending (without -).

  • Multiple sort criteria are supported.

Response

OK

firststring required

The URL path to the first page.

nextstring nullable

The URL path to the next page.

prevstring nullable

The URL path to the previous page.

selfstring required

The URL path to the current page.

total_countinteger nullable

Total number of items.

Example response

{
  "case_states": [
    {
      "case_type": "CUSTOMER_ONBOARDING",
      "name": "ONBOARDING_POSITIVE_END_STATE"
    }
  ],
  "first": "/v1/resource?page_number=1",
  "next": "/v1/resource?page_number=4",
  "prev": "/v1/resource?page_number=2",
  "self": "/v1/resource?page_number=3",
  "total_count": 60
}