List membership bundles
A paginated list of the membership bundles visible to the caller, sorted by
-ends_at by default. Administrators see all bundles; other users see the
bundles they own and those of organizations they manage.
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.
Filter predicates on membership-bundle attributes. 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 / date / datetime:
eq,not_eq,gt,gteq,lt,lteq,present,blank,null,not_null,in,not_in
_in / _not_in accept comma-separated values or repeated keys.
filter[active_at]=<datetime> returns bundles active at the given
time (including their grace period). The reserved key
filter[with_deleted]=true includes soft-deleted bundles (requires
elevated permission; otherwise 400).
Example: ?filter[ends_at_gteq]=2026-01-01
Sparse-fieldset selection.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/membership_bundles"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "membership_bundles", "attributes": { "name_en": "string", "name_fr": "string", "starts_at": "2019-08-24T14:15:22Z", "ends_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z", "grace_period_days": 0, "in_grace": true, "status": "string", "external_id": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z" }, "relationships": { "organization": { "data": { "type": "organizations", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "links": { "self": "/membership_bundles/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/organization", "related": "/membership_bundles/7247ad7d-9275-454b-9e3a-0570e403739e/organization" } }, "owner": { "data": { "type": "people", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "links": { "self": "/membership_bundles/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/owner", "related": "/membership_bundles/7247ad7d-9275-454b-9e3a-0570e403739e/owner" } }, "previous_membership_bundle": { "data": { "type": "membership_bundles", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "links": { "self": "/membership_bundles/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/previous_membership_bundle", "related": "/membership_bundles/7247ad7d-9275-454b-9e3a-0570e403739e/previous_membership_bundle" } }, "next_membership_bundle": { "data": { "type": "membership_bundles", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "links": { "self": "/membership_bundles/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/next_membership_bundle", "related": "/membership_bundles/7247ad7d-9275-454b-9e3a-0570e403739e/next_membership_bundle" } } }, "links": { "self": "/membership_bundles/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" } } ]}