Skip to main content
GET
List memberships
Date ranges: start_from/start_to, end_from/end_to, or created_from/created_to. Contacts / prices: repeat or comma-separate contact_id and membership_price_id. Use end_from/end_to to find memberships expiring within a window (renewal campaigns).

Authorizations

Authorization
string
header
required

OAuth2 access token. Pass the token in the Authorization header as Bearer <token>. The token is looked up in Redis to resolve the caller identity.

Query Parameters

limit
integer<int64>
default:20

Maximum number of items to return.

Required range: 1 <= x <= 1000
offset
integer<int64>
default:0

Number of items to skip.

Required range: x >= 0
start_from
string<date-time>

Only memberships starting on or after this date (RFC 3339).

start_to
string<date-time>

Only memberships starting on or before this date (RFC 3339).

end_from
string<date-time>

Only memberships ending on or after this date (RFC 3339).

end_to
string<date-time>

Only memberships ending on or before this date (RFC 3339).

created_from
string<date-time>

Only memberships created on or after this date (RFC 3339).

created_to
string<date-time>

Only memberships created on or before this date (RFC 3339).

amount_min
integer<int64>

Minimum amount in cents (inclusive).

Required range: x >= 0
amount_max
integer<int64>

Maximum amount in cents (inclusive).

Required range: x >= 0
contact_id
integer<int64>[] | null

Filter by one or more contact IDs (repeat or comma-separate).

Required range: x >= 0
membership_price_id
integer<int64>[] | null

Filter by one or more membership price IDs. See GET /v1/membership_prices.

Required range: x >= 0
sort
enum<string>
default:start_date

Sort column.

Available options:
created_at,
start_date,
end_date,
amount
order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc

Response

OK

data
object[] | null
required
status
string
required

Operation result.

Example:

"success"

total
integer<int64>
required

Total number of matching items.

Last modified on July 7, 2026