Skip to main content
GET
Get pension membership history

Authorizations

Authorization
string
header
required

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

Path Parameters

organization_id
required
employee_id
required

Response

Successful Response

valid_from
string<date>
required

Date from which this version of the membership record is effective

version
integer
required

Sequential version number; 0 = initial record, incremented on each change

status
enum<string>
required

Membership status at this version: ACTIVE, OPTED_OUT, or NOT_ENROLLED

Available options:
ACTIVE,
OPTED_OUT,
NOT_ENROLLED
worker_category
enum<string> | null
required

AE worker category recorded at this version; null if not yet assessed

Available options:
ELIGIBLE_JOBHOLDER,
NON_ELIGIBLE_JOBHOLDER,
ENTITLED_WORKER,
EXCLUDED
entry_route
enum<string> | null
required

How the employee entered the scheme at this version: AUTO_ENROLLED, OPTED_IN, or JOINED; null if not enrolled

Available options:
AUTO_ENROLLED,
OPTED_IN,
JOINED
enrolment_date
string<date> | null
required

Date enrolment took effect for this version; null if not enrolled

opt_out_date
string<date> | null
required

Date the employee opted out; null if not opted out at this version

enrolment_communication_date
string<date> | null
required

Date the statutory enrolment letter was sent; used for opt-out window validation

scheme_id
string | null
required

Pension scheme UUID at this version; null for pre-multi-scheme records

created_at
string<date-time>
required

Timestamp when this version was created

created_by
string | null
required

User identifier who created this version; null if system-generated

valid_to
string<date> | null

Date on which this version expires (exclusive); null = current version. Set automatically when a new version is created

employee_rate
string | null

Per-employee employee contribution rate override; null = use scheme default

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

Per-employee employer contribution rate override; null = use scheme default

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

Per-employee maximum employee contribution per period; null = use scheme default

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

Per-employee maximum employer contribution per period; null = use scheme default

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
tax_treatment
enum<string> | null

Per-employee tax treatment override (e.g. RELIEF_AT_SOURCE for an employee whose scheme is SALARY_SACRIFICE); null = use scheme default

Available options:
NET_PAY,
RELIEF_AT_SOURCE,
SALARY_SACRIFICE
wage_type_code
string | null

Per-employee wage type code override for the payslip deduction line; null = use scheme default. Required when tax_treatment override is set