Skip to main content

EmployeeFilterDTO

Employee filter request body. Every field is optional — an empty body {} returns the first page with the default ordering.

pageint32

Page number, 1-based. Min 1.

Possible values: >= 1

Default value: 1
Example: 1
sizeint32

Page size. Min 1, max 50.

Possible values: >= 1 and <= 50

Default value: 10
Example: 10
orders object

Sort order. Each key is a sort field — ID or FULL_NAME (see EmployeeOrderField) — and each value a direction. Keys are applied in the order they appear in the JSON object. Unless ID is one of the keys, a trailing ID DESC tie-breaker is appended so paging stays stable across requests. Omit (or send {}) to keep the default — newest ID first.

property name*string

Possible values: [ASC, DESC]

searchstring

Case-insensitive partial match against the employee's full name or phone number.

Default value:
Example: Sarvar
statusesUsersStatus[]

Filter by the status of the employee's linked user account. When omitted or empty all employees are returned, including those without a user account (status: null); when set, employees without a user account are excluded.

Possible values: [ENABLED, LOCKED, EXPIRED]

Example: ["ENABLED"]
EmployeeFilterDTO
{
  "page": 1,
  "size": 10,
  "orders": {
    "FULL_NAME": "ASC"
  },
  "search": "Sarvar",
  "statuses": [
    "ENABLED"
  ]
}