Skip to main content
GET
List pension schemes

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

organization_id
required

Response

Successful Response

valid_from
string<date>
required

Date from which this configuration version is effective

scheme_id
string
required

Stable handle UUID for the scheme; does not change when configuration is updated via PATCH. Use this in URL path segments and membership scheme_id fields

is_default
boolean
required

Whether this is the organisation's default scheme; only one scheme per org can be default. New eligible employees are auto-enrolled into the default scheme

scheme_name
string
required

Display name for the scheme

provider
enum<string>
required

Pension provider (NEST = National Employment Savings Trust, OTHER = any other provider)

Available options:
NEST,
OTHER
tax_treatment
enum<string>
required

Tax treatment method: NET_PAY (deducted pre-tax), RELIEF_AT_SOURCE (deducted post-tax, provider claims tax relief from HMRC), SALARY_SACRIFICE (employee gives up salary; saves NIC for both parties)

Available options:
NET_PAY,
RELIEF_AT_SOURCE,
SALARY_SACRIFICE
pensionable_earnings_definition
enum<string>
required

Earnings base for contribution calculation: QUALIFYING_EARNINGS (band £6,240–£50,270/year, 2025-26), PENSIONABLE_PAY (full pay, no lower threshold)

Available options:
QUALIFYING_EARNINGS,
PENSIONABLE_PAY
employee_rate
string
required

Employee contribution rate as a decimal (e.g. 0.05 = 5%); statutory minimum is 5% on qualifying earnings

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
employer_rate
string
required

Employer contribution rate as a decimal (e.g. 0.03 = 3%); statutory minimum is 3% on qualifying earnings

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
employee_cap
string | null
required

Maximum employee contribution per pay period as an absolute amount; null = no cap

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
employer_cap
string | null
required

Maximum employer contribution per pay period as an absolute amount; null = no cap

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
postponement_period_months
integer
required

Months to postpone auto-enrolment for newly eligible jobholders (0 = enrol immediately, max 3)

entitled_worker_employer_contributes
boolean
required

Whether the employer voluntarily contributes for Entitled Workers (earnings below £6,240/year) who choose to join the scheme

re_enrolment_date
string<date> | null
required

Employer's chosen cyclical re-enrolment date (every ~3 years); opted-out employees are re-enrolled on this date

re_enrolment_window_start
string<date> | null
required

Earliest permissible re-enrolment date (3 months before the staging anniversary)

re_enrolment_window_end
string<date> | null
required

Latest permissible re-enrolment date (3 months after the staging anniversary)

wage_type_code
string
required

Wage type code used for the pension deduction line item on payslip; must be PENSION category. NET_PAY/RAS use UK-P-001 or UK-P-002; SALARY_SACRIFICE requires UK-P-003

created_at
string<date-time>
required

Timestamp when this configuration version was created

valid_to
string<date> | null

Date on which this version expires (exclusive); null means this is the current active version. Populated automatically when a newer version is created via PATCH

created_by
string | null

User identifier (from JWT sub) who created this version; null if created by the system