Membership catalog (assortment available for sale)
Header Parameters
Api-Keystring
Query Parameters
organization_idinteger
Branch — return root memberships and this branch's memberships.
sale_organization_idinteger
Branch in which the membership is sold.
access_organization_idinteger
Branch the membership grants access to.
kindinteger
Membership kind ID (ticket_kind_id).
subscriptionboolean
true — only with auto-renewal, false — only without.
segmentinteger
Access segment ID.
detalizationboolean
true — include a detalization object for each membership with
the addons, step_payments, and service_payments arrays, and
also return total_price (first payment if the membership starts today).
startinteger
1-based index of the first record to return (offset = start - 1).
Defaults to 1.
Minimum
1
Default value
1
limitinteger
Page size. Defaults to 25; values above 100 are silently capped
to 100.
Minimum
1
Maximum
100
Default value
25
Response
200
Object
Membership catalog (crud envelope)
Response Attributes
successboolean
dataarray
Show child attributes
errorstring
error_codeinteger
totalinteger | null
summaryobject
401
Object
Session not established / invalid key.
Response Attributes
successboolean
dataarray
errorstring
session_expiredboolean
totalinteger
Was this section helpful?
Response
Was this section helpful?