Skip to main content
GET
List rule assignments for a member

Authorizations

X-API-KEY
string
header
required

Path Parameters

member_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Query Parameters

allowance_type_id
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Response

Successful response

id
number
required
rule_start_date
string
required

First day the assignment itself applies (inclusive). This is the assignment's own validity, which is independent of the member: it does not account for a member who joined after it began. Matches what POST and PATCH accept, so values can be round-tripped — use coverage_start_date to see when the member actually starts accruing.

coverage_start_date
string
required

First day this MEMBER actually accrues under the assignment (inclusive): rule_start_date, moved forward to the member's employment_start_date when they joined after the assignment began and before it ended. For an assignment that ended on or before the member's employment start, the member never accrued under it at all and this field simply equals rule_start_date (that state is detectable as rule_end_date <= employment_start_date). Read-only and derived — POST and PATCH do not accept it, and writing it back into rule_start_date would freeze a hire date that is still editable.

rule_end_date
string | null
required

Last day the rule applies (inclusive), or null for open-ended. Matches what POST and PATCH accept, so values can be round-tripped.

allowance_type_id
string
required
rule_id
string
required
rule
object
required