Sign in
latestOpenAPI 3.1.02026-08-22695252.1 KB

ef777d51e6f2

Allowance Management

Read a member's rule history

Every assignment-level entry referencing this member, newest first: which rule they were put on, moved to, or removed from, by whom and why.

get/members/{member_id}/rule-audit-log

Path parameters

member_idstring uuid required

Query parameters

allowance_type_idstring uuid
takeinteger

Response

Successful response

idnumber required
createdAtstring required
rule_idstring required
allowance_type_idstring required
event_type'RULE_CREATED' | 'RULE_UPDATED' | 'RULE_DELETED' | 'ASSIGNMENT_CREATED' | 'ASSIGNMENT_UPDATED' | 'ASSIGNMENT_DELETED' | 'MEMBER_RULE_CHANGED' | 'DEFAULT_RULE_CHANGED' required
actor_member_idstring nullable required

Null once the member who made the change has been deleted.

member_idstring nullable required

Set on assignment-level events: the member they affected.

commentstring nullable required

The reason given for the change.

{"stackTrail":"paths:/members/{member_id}/rule-audit-log:get:responses:200:content:application/json:schema:items:properties:changes","oasType":"schema","type":"unknown","description":"What changed, as a JSON object. Rule edits carry `{ field: { from, to } }` pairs; a rule change carries `from_rule_id` / `to_rule_id`. The exact keys depend on `event_type`."}
affected_member_countnumber required

How many members were on the rule when the change was made.

rule_namestring nullable required
from_rule_idstring nullable required

The rule the member was on before this entry.

to_rule_idstring nullable required

The rule the member was on after it.

from_rule_namestring nullable required
to_rule_namestring nullable required