Skip to main content
GET
List Absence Scheme Editions

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required
scheme_id
string
required

Response

Successful Response

scheme_id
string
required
edition_id
integer
required
name
string
required
valid_from
string<date>
required
terms
GBSchemeTerms · object
required

The occupational scheme terms: which statutory regime the scheme tops up, how the top-up composes with statutory pay, what it is measured against, and the week bands that set the occupational pay level.

created_at
string<date-time>
required
effective_offset_mode
enum<string>
required
read-only

How the occupational top-up actually composes with the statutory line for these terms

Available options:
INCLUSIVE,
ADDITIVE,
SUBSTITUTIVE
valid_to
string<date> | null