List person member histories
Lists computed person member-history records. Defaults to the
category_organization rollup; pass a rollup_type filter predicate
(e.g. filter[rollup_type_eq]=category or filter[rollup_type_eq]=all)
to change this. Only records with at least one membership entry are
returned.
Authorization
bearerAuth In: header
Query Parameters
Comma-separated list of relationships to include. Allowed values are resource-specific; consult the operation for the allowlist.
Comma-separated list of attributes to sort by. Prefix with - for
descending order (-created_at,family_name).
Offset pagination parameters.
Keys take the form filter[<attribute>_<predicate>]=<value>, repeatable per query.
Common predicates by attribute type:
- String / text / uuid:
eq,not_eq,cont,not_cont,matches,start,end,present,blank,null,not_null,in,not_in - Integer / decimal / date / datetime:
eq,not_eq,gt,gteq,lt,lteq,present,blank,null,not_null,in,not_in - Boolean:
eq,not_eq,present,blank,null,not_null
Example: ?filter[status_eq]=Active
Sparse-fieldset selection.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/person_member_histories"{ "data": [ { "type": "person_member_histories", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "attributes": { "rollup_type": "category_organization", "category": "string", "status": "string", "member_since": "2019-08-24T14:15:22Z", "current_starts_at": "2019-08-24T14:15:22Z", "current_ends_at": "2019-08-24T14:15:22Z", "current_expires_at": "2019-08-24T14:15:22Z", "latest_created_at": "2019-08-24T14:15:22Z", "latest_updated_at": "2019-08-24T14:15:22Z", "continuous_starts_at": "2019-08-24T14:15:22Z", "continuous_ends_at": "2019-08-24T14:15:22Z", "max_ends_at": "2019-08-24T14:15:22Z", "previous_continuous_ends_at": "2019-08-24T14:15:22Z", "previous_lapsed_duration_days": 0 }, "relationships": { "person": { "data": { "type": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "links": { "self": "../dictionary", "related": "../dictionary" } }, "organization": { "data": { "type": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "links": { "self": "../dictionary", "related": "../dictionary" } }, "latest_membership_entries": { "data": [ { "type": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } ], "links": { "self": "../dictionary", "related": "../dictionary" } }, "membership_entries": { "data": [ { "type": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } ], "links": { "self": "../dictionary", "related": "../dictionary" } } }, "links": { "property1": "/person_member_histories/7247ad7d-9275-454b-9e3a-0570e403739e", "property2": "/person_member_histories/7247ad7d-9275-454b-9e3a-0570e403739e" } } ], "meta": { "page": { "total_items": 0, "total_pages": 0, "number": 0, "size": 0 } }}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}