Lists company scheduling options

Retrieves a list of all scheduling options available for the company. These options define the types of statuses that can be assigned to users (e.g., Office, Mobile work, Absent). Returns option details including ID, name, type, color, display order, primary status (cannot be deleted), active status (inactive options cannot be used for new statuses), and policy rule (how the status counts toward Hybrid Work Policy). Primary options are system-defined and cannot be deleted.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200OK

application/json

List of company scheduling options, that can be used to set scheduling statuses

Bodyapplication/json

Example

{
    "id": "46e51f33-2b6e-43d2-b4d8-d1e79ba34458",
    "name": "Mobile work",
    "type": "mobile_work",
    "color": "#916BFF",
    "order": 1,
    "isPrimary": false,
    "isActive": true,
    "policyRule": "remote"
}

Lists company scheduling options

Request

Request Code Samples

Responses