Skip to main content
GET
Read a member's rule history

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}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

allowance_type_id
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
take
integer
default:100
Required range: 1 <= x <= 200

Response

Successful response

id
number
required
createdAt
string
required
rule_id
string
required
allowance_type_id
string
required
event_type
enum<string>
required
Available options:
RULE_CREATED,
RULE_UPDATED,
RULE_DELETED,
ASSIGNMENT_CREATED,
ASSIGNMENT_UPDATED,
ASSIGNMENT_DELETED,
MEMBER_RULE_CHANGED,
DEFAULT_RULE_CHANGED
actor_member_id
string | null
required

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

member_id
string | null
required

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

comment
string | null
required

The reason given for the change.

changes
any
required

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_count
number
required

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

actor
object | null
required
rule_name
string | null
required
from_rule_id
string | null
required

The rule the member was on before this entry.

to_rule_id
string | null
required

The rule the member was on after it.

from_rule_name
string | null
required
to_rule_name
string | null
required