Skip to main content
GET
Get Absence

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required
employee_id
string
required
absence_id
string
required

Query Parameters

as_of
string<date-time> | null

Read the store as known at this instant (the retro seam): only editions with created_at <= as_of are considered. A caller that issues several reads for one decision, such as a payroll run, captures one timestamp and passes it to all of them.

Response

Successful Response

One edition, as stored. created_at is the edition's transaction time.

start_date
string<date>
required

First day of leave (inclusive)

end_date
string<date>
required

Last day of leave (inclusive); return to work is the next day

content
GBMaternityAbsence · object
required

GB maternity content payload. ewc anchors the qualifying-week and MPP derivations, so it must be the SUNDAY the expected week of childbirth starts on (HMRC weeks run Sunday to Saturday); rejecting anything else is correct-by-policy rather than silently normalising a caller bug.

absence_id
string
required
employee_id
string
required
created_at
string<date-time>
required
country_code
string
default:GB
Allowed value: "GB"
external_ref
string | null

AMS correlation reference

is_cancelled
boolean
default:false