7b222e8ec91c
List issued memberships
Returns paginated issued memberships
Query parameters
The number of items to retrieve
Cursor for pagination. Returns records after this ID (e.g. im_123)
Cursor for pagination (previous page). Returns records before this ID (e.g. im_123)
Filter by first name (contains)
Filter by last name (contains)
Filter by email (contains)
Search by first name, last name or email (contains)
Filter by exact membership code
Filter by membership validity status. 'valid' returns only currently valid memberships, 'invalid' returns expired or voided memberships, 'both' returns all.
Order results by member's first_name or last_name
Sort direction when order_by is specified
Unix timestamp filter that returns issued memberships issued on or after the given value.
Unix timestamp filter that returns issued memberships issued before the given value.
Unix timestamp filter that returns issued memberships whose valid_from is on or after the given value.
Unix timestamp filter that returns issued memberships whose valid_from is before the given value.
Unix timestamp filter that returns issued memberships whose valid_to is on or after the given value.
Unix timestamp filter that returns issued memberships whose valid_to is before the given value.
Response
A successfully returned list of issued memberships
Example response
{
"data": [
{
"object": "issued_membership",
"id": "im_123",
"code": "MMABC123",
"benefits": [
"Free entry to all events",
"10% discount on merchandise"
],
"email": "john.doe@example.com",
"first_name": "John",
"full_name": "John Doe",
"is_valid": "true",
"issue_date": {
"date": "2024-01-01",
"formatted": "Mon 1 Jan 2024 12:00 PM",
"iso": "2024-01-01T12:00:00+00:00",
"time": "12:00",
"timezone": "+00:00",
"unix": 1704110400
},
"last_name": "Doe",
"max_redemptions": 10,
"membership_type_id": "mt_456",
"membership_type_name": "Annual Pass",
"redemption_collection": [],
"redemptions": 0,
"valid_from": {
"date": "2024-01-01",
"formatted": "Mon 1 Jan 2024 12:00 PM",
"iso": "2024-01-01T12:00:00+00:00",
"time": "12:00",
"timezone": "+00:00",
"unix": 1704110400
},
"valid_to": {
"date": "2024-12-31",
"formatted": "Tue 31 Dec 2024 11:59 PM",
"iso": "2024-12-31T23:59:59+00:00",
"time": "23:59",
"timezone": "+00:00",
"unix": 1735689599
},
"voided_at": null
}
],
"links": {
"next": "/v1/issued_memberships?starting_after=im_120",
"previous": "/v1/issued_memberships?ending_before=im_100"
}
}