---
title: "Get order statuses with filters"
method: GET
path: "/order-status"
tags: ["Order Status Controller"]
---

# Get order statuses with filters

`GET /order-status`

Retrieve order statuses with optional search by status name and pagination.

## Query parameters

- `search` string
- `isSystemDefined` boolean
- `sortBy` 'status' | 'createdAt' | 'isSystemDefined'
- `sortType` 'ASC' | 'DESC'
- `page` number, required
- `size` number, required

## Response `200`

Order statuses retrieved successfully

- OrderStatusListResponseDto
  - `totalItems` number, required — Total number of items
  - `items` OrderStatusResponseDto[], required — List of order statuses
    - `id` number, required — Order status ID
    - `status` string, required — Order status name
    - `backgroundColor` string — Background color for the status
    - `textColor` string — Text color for the status
    - `borderColor` string — Border color for the status
    - `isSystemDefined` boolean, required — Whether this status is system defined
    - `createdByName` string — Created by user name
  - `page` number, required — Current page number
  - `size` number, required — Number of items per page

---

[API](https://skmtc.dev/findmydocument/apis/land-registry-api.md) · [All operations](https://skmtc.dev/findmydocument/apis/land-registry-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/findmydocument/land-registry-api/revisions/b55a990514fb/schema)