Get Schedulers

Retrieve a list of all schedulers (schedules) in your Connecteam account.

Endpoint

GET /scheduler/v1/schedulers

Authentication

Request

This endpoint has no query parameters or request body.

curl --request GET \
  --url https://api.connecteam.com/scheduler/v1/schedulers \
  --header 'X-API-KEY: YOUR_API_KEY'

Response

Success Response (200 OK)

{
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "data": {
    "schedulers": [
      {
        "schedulerId": 9454799,
        "name": "Main Schedule",
        "isArchived": false,
        "timezone": "America/New_York"
      },
      {
        "schedulerId": 9454800,
        "name": "Warehouse Team",
        "isArchived": false,
        "timezone": "America/Chicago"
      },
      {
        "schedulerId": 9454801,
        "name": "Old Schedule",
        "isArchived": true,
        "timezone": "America/Los_Angeles"
      }
    ]
  }
}

Response Fields

📝

Note

Archived schedulers are returned in the response but are read-only. You cannot create or modify shifts in archived schedulers.

Using the Scheduler ID

The schedulerId is required for all other Scheduler API endpoints:

• /scheduler/v1/schedulers/{schedulerId}/shifts
• /scheduler/v1/schedulers/{schedulerId}/shift-layers
• /scheduler/v1/schedulers/{schedulerId}/unavailabilities
• /scheduler/v1/schedulers/{schedulerId}/shifts/auto-assign

🚧

Important

Always verify the scheduler is not archived (isArchived: false) before attempting write operations.

Scheduler Timezone

The scheduler's timezone affects:

• Default timezone for new shifts (when not explicitly specified)
• Work week boundaries for auto-assign operations
• Display of shift times in the Connecteam app

Error Responses

API Reference