---
title: "List state machines"
method: GET
path: "/api/v1/state-machines"
tags: ["state-machines"]
---

# List state machines

`GET /api/v1/state-machines`

Returns a paginated list of state machines for an entity type within the caller account.

## Query parameters

- `q` string
- `entityType` string, required
- `page` number
- `limit` number
- `sortBy` string
- `sortOrder` string

## Response `200`

Paginated list of state machines.

- StateMachineListResponse
  - `data` StateMachineListItemResponse[], required
    - `states` object[], required
      - `status` string
      - `label` string
      - `color` string, nullable
      - `actions` string[]
    - `id` string, required
    - `entity_type` 'ORDER' | 'FULFILLMENT_ORDER', required
    - `code` string, required
    - `name` string, required
    - `transitions` object[], required
      - `from` string, required
      - `to` string, required
    - `active` boolean, required
    - `is_default` boolean, required
    - `version` number, required
    - `created_at` string, required
    - `updated_at` string, required
  - `meta` PaginationMetaResponse, required
    - `total` number, required — Total number of records that match the filter.
    - `pages` number, required — Number of pages available.
    - `current_page` number, required — Page number returned in this response.
    - `next_page` number, nullable, required — Next page number, or null when on the last page.
    - `previous_page` number, nullable, required — Previous page number, or null when on the first page.
    - `limit` number, required — Page size used to compute pagination.

## Other responses

- `400` — Invalid query parameters (entityType, pagination).
- `401` — Authentication is missing, malformed, expired, or refers to a session that is no longer active.
- `403` — The caller is authenticated but lacks the required permission for this action.
- `500` — Unexpected server error. The response body never leaks internal details.

---

[API](https://skmtc.net/kruzer-corp/apis/oms-api.md) · [All operations](https://skmtc.net/kruzer-corp/apis/oms-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kruzer-corp/oms-api/revisions/38ef6e16a7a8/schema)