Skip to main content
GET
List Schedules

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.
  • All schedule kinds: An unfiltered list requires both permissions.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

team_id
string
required

The ID of the team to list schedules for.

Query Parameters

kind
enum<string> | null

ScheduleKind distinguishes a recurring weekly schedule's role.

Available options:
SCHEDULE_KIND_UNSPECIFIED,
SCHEDULE_KIND_WORK_HOURS,
SCHEDULE_KIND_BLACKOUT
pageSize
integer<int32>
pageToken
string

Response

200 - application/json

Success

data
Schedule · object[]
nextPageToken
string | null