List scheduling patterns

Typed daily, weekly, rotation and historical legacy_rotation patterns at their current revision. Requires manage_rotations.

GET /api/v1/workforce/scheduling-patterns

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {}
  ],
  "nextCursor": "<string>",
  "complete": true
}

Authorizations

Authorization · string · header · required

Existing Atlas integration connection with explicit api:connect plus appropriate native domain grants. atlas_ingest_ and browser cookies are not accepted.

Headers

X-Workspace-Id · string<uuid> · required

Selector within saved grants and current issuer authority; never grants authority.

Query Parameters

kind · enum<string>

Restrict to one kind.

Available options: daily, weekly, rotation, legacy_rotation

include_archived · boolean · default: false

Include archived patterns.

cursor · string

Continuation from the previous page's nextCursor.

limit · integer · default: 50

Page size.

Required range: 1 <= x <= 100

Response

200

application/json

Native typed result.

One page of native records. complete is false while nextCursor continues the list; a failed read is an error, never an empty page.

items · object[] · required

nextCursor · string | null · required

complete · boolean · required