Returns a deterministic cursor page of active or historical exceptions.

POST

/api/workspace/work-schedule/exceptions/query

curl --request POST \
  --url https://example.com/api/workspace/work-schedule/exceptions/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "StartLocalDate": "2026-04-15", "EndLocalDate": "2026-04-15", "WorkerIds": [ "example" ], "SiteIds": [ "example" ], "Cursor": "example", "PageSize": 1, "IncludeInactive": true }'

Authorizations

• WorkspaceBearer

Parameters

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

Queries bounded schedule-exception evidence with deterministic cursor paging.

object

StartLocalDate

string format: date

EndLocalDate

string format: date

WorkerIds

Array<string>

nullable

SiteIds

Array<string>

nullable

Cursor

string

nullable

PageSize

integer format: int32

IncludeInactive

boolean

Example^generated

{
  "StartLocalDate": "2026-04-15",
  "EndLocalDate": "2026-04-15",
  "WorkerIds": [
    "example"
  ],
  "SiteIds": [
    "example"
  ],
  "Cursor": "example",
  "PageSize": 1,
  "IncludeInactive": true
}

Queries bounded schedule-exception evidence with deterministic cursor paging.

object

StartLocalDate

string format: date

EndLocalDate

string format: date

WorkerIds

Array<string>

nullable

SiteIds

Array<string>

nullable

Cursor

string

nullable

PageSize

integer format: int32

IncludeInactive

boolean

Example^generated

{
  "StartLocalDate": "2026-04-15",
  "EndLocalDate": "2026-04-15",
  "WorkerIds": [
    "example"
  ],
  "SiteIds": [
    "example"
  ],
  "Cursor": "example",
  "PageSize": 1,
  "IncludeInactive": true
}

Queries bounded schedule-exception evidence with deterministic cursor paging.

object

StartLocalDate

string format: date

EndLocalDate

string format: date

WorkerIds

Array<string>

nullable

SiteIds

Array<string>

nullable

Cursor

string

nullable

PageSize

integer format: int32

IncludeInactive

boolean

Example^generated

{
  "StartLocalDate": "2026-04-15",
  "EndLocalDate": "2026-04-15",
  "WorkerIds": [
    "example"
  ],
  "SiteIds": [
    "example"
  ],
  "Cursor": "example",
  "PageSize": 1,
  "IncludeInactive": true
}

Responses

200

OK

Media typeapplication/json

object

Data

Deterministic cursor page of exception evidence.

object

Items

Array<object>

nullable

One immutable schedule-exception evidence entry.

object

ExceptionId

string

nullable

ChainRootId

string

nullable

Sequence

integer format: int64

OperationKind

string

nullable

Kind

string

nullable

ScopeType

string

nullable

ScopeId

string

nullable

WorkerId

string

nullable

SiteId

string

nullable

DestinationSiteId

string

nullable

WorkingCalendarId

string

nullable

IsWholeDay

boolean

StartLocalDate

string format: date

EndLocalDateExclusive

string format: date

Intervals

Array<object>

nullable

One exact local interval with frozen boundary provenance where applicable.

object

StartLocalDate

string format: date

StartLocalTime

string format: time

EndLocalDate

string format: date

EndLocalTime

string format: time

BoundaryIanaTimeZoneId

string

nullable

ResolvedStartUtc

string format: date-time

nullable

ResolvedEndUtc

string format: date-time

nullable

ReasonCode

string

nullable

ReasonText

string

nullable

AuthorityTier

string

nullable

BoundaryIanaTimeZoneId

string

nullable

ResolvedStartUtc

string format: date-time

nullable

ResolvedEndUtcExclusive

string format: date-time

nullable

RecordedAtUtc

string format: date-time

RecordedByUserId

string

nullable

RecordedByActor

Compact read model for user references inside runtime instance payloads.

object

Id

User identifier.

string

nullable

Name

Resolved user display name.

string

nullable

SupersedesOverrideId

string

nullable

Diagnostics

Array<object>

nullable

One structured daylight-saving boundary diagnostic.

object

Code

string

nullable

Field

string

nullable

IntervalOrdinal

integer format: int32

nullable

NextCursor

string

nullable

Actions

Server-computed actions for the queried exception collection and resource scope.

object

CreateTargets

Array<object>

nullable

One server-authorized create target and the reason codes available for it.

object

ScopeType

string

nullable

ScopeId

string

nullable

ReasonCodes

Array<string>

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}