# Get roster types

Returns roster (duty) types with pagination. This endpoint supports only pagination: send limit and offset in the request body. Filters and sorts are not supported for roster types; do not send filters or sorts.

Each item is a simplified type (id, name, displayLabel, isNative, isCustom, displayOrder, nestedTypes). Use GET /api/v2/roster-types/{id} for the full type including boolean flags.

Endpoint: POST /api/v2/roster-types-search
Version: 2.4.0
Security: X-Api-Client-Id, X-Auth-Token

## Request fields (application/json):

  - `limit` (integer)
    Maximum number of root-level roster types to return.
    Example: 20

  - `offset` (integer)
    Number of root-level records to skip.

## Response 200 fields (application/json):

  - `data` (array)
    The list of roster types for the current page (root level; each may have nestedTypes).

  - `data.id` (string)
    Unique identifier of the roster type. Use as rosterTypeId when creating/updating assignments.
    Example: "112233"

  - `data.name` (string)
    Short code (e.g. OFF, TRV, FLT).
    Example: "OFF"

  - `data.displayLabel` (string)
    Label shown in the UI.
    Example: "Off"

  - `data.isNative` (boolean)
    True if system duty kind; false for custom variants.

  - `data.isCustom` (boolean)
    True if added or customized by the operator.

  - `data.displayOrder` (integer)
    Sort order in lists and trees.

  - `data.nestedTypes` (array)
    Child roster types (same simplified structure recursively).

  - `pagination` (object)
    Pagination details

  - `pagination.offset` (integer)
    Number of records skipped

  - `pagination.limit` (integer)
    Maximum number of records returned
    Example: 20

  - `pagination.totalItems` (integer)
    Total number of items available
    Example: 150

  - `pagination.sortItems` (array)
    List of fields used for sorting
    Example: ["issueDate desc"]

  - `pagination.filters` (array)
    List of applied filters

  - `pagination.filters.field` (string)
    Field name to filter by
    Example: "issueDate"

  - `pagination.filters.operator` (string)
    Filter operator
    Example: "gte"

  - `pagination.filters.value` (string)
    Filter value
    Example: "2024-01-01T00:00:00.000Z"


## Response 401 fields

## Response 403 fields