# Roster Types

Retrieve roster (duty) types that define which fields and behaviors are available when creating or updating a roster assignment. These endpoints provide access to the operator's roster configuration, enabling dynamic UI and validation.

**Business Value**
- Ensure accurate roster data by identifying relevant fields for each duty type.
- Align integration behavior with the operator’s specific roster configuration.
- Support dynamic roster interfaces that only display fields enabled for the selected type.
- Streamline the roster management process by reducing validation errors.

<br/>

**Use Cases**
- Retrieve the full list of available roster types and their hierarchical structure.
- Inspect a specific roster type to determine which features (e.g., aircraft, airports, FTL) are enabled.
- Build dynamic forms that adapt based on the chosen roster duty type.

<br/>


## Get roster types

 - [POST /api/v2/roster-types-search](https://developer.fl3xx.com/reference/v2/roster-types/rostertypessearch.md): 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.

## Get roster type

 - [GET /api/v2/roster-types/{id}](https://developer.fl3xx.com/reference/v2/roster-types/rostertypebyidget.md): Retrieves detailed information for a specific roster type by its unique identifier.

Features:
- Returns boolean flags indicating enabled features (aircraft, airports, logbook, FTL, etc.)
- Provides configuration details for specific duty fields
- Supports dynamic UI validation based on the roster type

Example Use Case: Before creating a roster assignment, the system calls this endpoint to check if the chosen duty type requires aircraft and airport information, ensuring only relevant fields are presented to the user.