Users
User management, authentication, profiles, and account operations.
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Query parameters
expandstring[]OptionalExample:
["items._links.membership"]Responses
200
Returns a MembershipSubscriptionCollection
application/json
_totalnumberRequired
get/users/{userId}/memberships
GET /apis/v2/users/{userId}/memberships HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a MembershipSubscriptionCollection
{
"items": [
{
"id": "text",
"displayName": "text",
"type": "GLOBAL_MEMBER",
"status": "DRAFT",
"extendedStatus": "ACTIVE",
"mode": "PREVIEW",
"condition": "VALID",
"conditionUpdatedDate": "2026-01-01T00:00:00.000Z",
"createdDate": "2026-01-01T00:00:00.000Z",
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"cancellationRequestDate": "2026-01-01T00:00:00.000Z",
"lastChargeDate": "2026-01-01T00:00:00.000Z",
"nextChargeDate": "2026-01-01T00:00:00.000Z",
"lastGrantDate": "2026-01-01T00:00:00.000Z",
"nextGrantDate": "2026-01-01T00:00:00.000Z",
"billingCycleStart": "2026-01-01T00:00:00.000Z",
"billingCycleEnd": "2026-01-01T00:00:00.000Z",
"activePause": {
"id": "text",
"pauseStartDate": "2026-01-01T00:00:00.000Z",
"pauseEndDate": "2026-01-01T00:00:00.000Z",
"pauseDurationWeeks": 1,
"pauseFeePaid": 1,
"status": "PENDING",
"createdAt": "2026-01-01T00:00:00.000Z",
"membershipSubscription": {
"id": "text"
},
"_links": {}
},
"timezone": "text",
"price": 1,
"initiationFee": 1,
"durationDays": 1,
"oneTimeOption": {
"id": "text"
},
"total": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"fees": [
{
"name": "Credit Card Fee",
"percentage": 2.9,
"amount": 100
}
],
"additionalMemberFee": 1,
"chargeType": "FREE",
"member": {
"id": "text"
},
"membership": {
"id": "text"
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"order": {
"id": "text"
},
"summary": {
"total": 1,
"membershipPrice": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"fees": [
{
"name": "Credit Card Fee",
"percentage": 2.9,
"amount": 100
}
],
"messages": [
{
"code": "text",
"message": "text"
}
],
"billingCycleStart": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"initiationFee": 1,
"chargeType": "FREE"
},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Header parameters
user-agentstringRequired
Body
idstringRequired
displayNamestringRequired
typestring · enumRequiredPossible values:
statusstring · enumRequiredPossible values:
extendedStatusstring · enumRequiredPossible values:
modestring · enumRequiredPossible values:
conditionstring · enumRead-onlyRequiredPossible values:
conditionUpdatedDatestring · date-timeRead-onlyRequired
createdDatestring · date-timeRequired
startDatestring · date-timeRequired
endDatestring · date-timeRequired
cancellationRequestDatestring · date-timeRequired
lastChargeDatestring · date-timeRequired
nextChargeDatestring · date-timeRequired
lastGrantDatestring · date-time · nullableRead-onlyRequired
The last time the membership perks were granted to the user
nextGrantDatestring · date-timeRequired
billingCycleStartstring · date-timeRequired
billingCycleEndstring · date-timeRequired
timezonestringRequired
The timezone used to display and calculate charge and grant dates for the subscription.
pricenumber · nullableRequired
initiationFeenumber · nullableRequired
durationDaysnumber · nullableRequired
The number of days the membership will be active for if the charge type is non-recurring
totalnumber · nullableRequired
additionalMemberFeenumber · nullableRequired
chargeTypestring · enumRequiredPossible values:
_linksobjectRequired
Responses
200
Returns a MembershipSubscription
application/json
idstringRequired
displayNamestringRequired
typestring · enumRequiredPossible values:
statusstring · enumRequiredPossible values:
extendedStatusstring · enumRequiredPossible values:
modestring · enumRequiredPossible values:
conditionstring · enumRead-onlyRequiredPossible values:
conditionUpdatedDatestring · date-timeRead-onlyRequired
createdDatestring · date-timeRequired
startDatestring · date-timeRequired
endDatestring · date-timeRequired
cancellationRequestDatestring · date-timeRequired
lastChargeDatestring · date-timeRequired
nextChargeDatestring · date-timeRequired
lastGrantDatestring · date-time · nullableRead-onlyRequired
The last time the membership perks were granted to the user
nextGrantDatestring · date-timeRequired
billingCycleStartstring · date-timeRequired
billingCycleEndstring · date-timeRequired
timezonestringRequired
The timezone used to display and calculate charge and grant dates for the subscription.
pricenumber · nullableRequired
initiationFeenumber · nullableRequired
durationDaysnumber · nullableRequired
The number of days the membership will be active for if the charge type is non-recurring
totalnumber · nullableRequired
additionalMemberFeenumber · nullableRequired
chargeTypestring · enumRequiredPossible values:
_linksobjectRequired
409
Returns an error
application/json
422
Returns an ErrorDto in case of validation errors or failures.
Possible error codes are:MS001: A payment method is required to continue.MS002: The payment method is not active.MS003: A phone number is required.MS010: You are not allowed to perform this action.MS011: Custom price cannot be 0, use Free instead.MS012: We've reached the maximum number of members for this membershipMS013: To change from monthly to annual payment or vice versa, you must first cancel your current membershipMS014: To change your membership plan, you must first cancel your current membershipMS015: This membership is not available for purchase on the selected payment planMS016: To change your membership plan, you must wait until your current membership cancellation is effectiveMS017: Liability waiver acceptance is required.MS018: Liability Waiver agreement not found. Please contact support.MS019: Custom price cannot be 0 for non-recurring memberships. Only admins can create free passes.MS020: Invalid membership configuration. Please contact support.MS021: To change your membership plan, your current membership cannot be paused or pending pause.MS040: Unable to proceed with the current payment method. Please try using a different one.MS041: Prepaid cards are not accepted, please use a credit or debit card.RA001: Could not confirm the payment. Please try again.
post/users/{userId}/memberships
POST /apis/v2/users/{userId}/memberships HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
user-agent: text
Content-Type: application/json
Accept: */*
Content-Length: 769
{
"id": "text",
"displayName": "text",
"type": "GLOBAL_MEMBER",
"status": "DRAFT",
"extendedStatus": "ACTIVE",
"mode": "PREVIEW",
"createdDate": "2026-01-01T00:00:00.000Z",
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"cancellationRequestDate": "2026-01-01T00:00:00.000Z",
"lastChargeDate": "2026-01-01T00:00:00.000Z",
"nextChargeDate": "2026-01-01T00:00:00.000Z",
"nextGrantDate": "2026-01-01T00:00:00.000Z",
"billingCycleStart": "2026-01-01T00:00:00.000Z",
"billingCycleEnd": "2026-01-01T00:00:00.000Z",
"activePause": {
"_links": {}
},
"timezone": "text",
"price": 1,
"initiationFee": 1,
"durationDays": 1,
"oneTimeOption": {
"id": "text"
},
"total": 1,
"additionalMemberFee": 1,
"chargeType": "FREE",
"member": {
"id": "text"
},
"membership": {
"id": "text"
},
"order": {
"id": "text"
},
"_links": {}
}{
"id": "text",
"displayName": "text",
"type": "GLOBAL_MEMBER",
"status": "DRAFT",
"extendedStatus": "ACTIVE",
"mode": "PREVIEW",
"condition": "VALID",
"conditionUpdatedDate": "2026-01-01T00:00:00.000Z",
"createdDate": "2026-01-01T00:00:00.000Z",
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"cancellationRequestDate": "2026-01-01T00:00:00.000Z",
"lastChargeDate": "2026-01-01T00:00:00.000Z",
"nextChargeDate": "2026-01-01T00:00:00.000Z",
"lastGrantDate": "2026-01-01T00:00:00.000Z",
"nextGrantDate": "2026-01-01T00:00:00.000Z",
"billingCycleStart": "2026-01-01T00:00:00.000Z",
"billingCycleEnd": "2026-01-01T00:00:00.000Z",
"activePause": {
"id": "text",
"pauseStartDate": "2026-01-01T00:00:00.000Z",
"pauseEndDate": "2026-01-01T00:00:00.000Z",
"pauseDurationWeeks": 1,
"pauseFeePaid": 1,
"status": "PENDING",
"createdAt": "2026-01-01T00:00:00.000Z",
"membershipSubscription": {
"id": "text"
},
"_links": {}
},
"timezone": "text",
"price": 1,
"initiationFee": 1,
"durationDays": 1,
"oneTimeOption": {
"id": "text"
},
"total": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"fees": [
{
"name": "Credit Card Fee",
"percentage": 2.9,
"amount": 100
}
],
"additionalMemberFee": 1,
"chargeType": "FREE",
"member": {
"id": "text"
},
"membership": {
"id": "text"
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"order": {
"id": "text"
},
"summary": {
"total": 1,
"membershipPrice": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"fees": [
{
"name": "Credit Card Fee",
"percentage": 2.9,
"amount": 100
}
],
"messages": [
{
"code": "text",
"message": "text"
}
],
"billingCycleStart": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"initiationFee": 1,
"chargeType": "FREE"
},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
membershipSubscriptionIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Query parameters
expandstring[]OptionalExample:
["_links.membership"]Responses
200
Returns a MembershipSubscription
application/json
idstringRequired
displayNamestringRequired
typestring · enumRequiredPossible values:
statusstring · enumRequiredPossible values:
extendedStatusstring · enumRequiredPossible values:
modestring · enumRequiredPossible values:
conditionstring · enumRead-onlyRequiredPossible values:
conditionUpdatedDatestring · date-timeRead-onlyRequired
createdDatestring · date-timeRequired
startDatestring · date-timeRequired
endDatestring · date-timeRequired
cancellationRequestDatestring · date-timeRequired
lastChargeDatestring · date-timeRequired
nextChargeDatestring · date-timeRequired
lastGrantDatestring · date-time · nullableRead-onlyRequired
The last time the membership perks were granted to the user
nextGrantDatestring · date-timeRequired
billingCycleStartstring · date-timeRequired
billingCycleEndstring · date-timeRequired
timezonestringRequired
The timezone used to display and calculate charge and grant dates for the subscription.
pricenumber · nullableRequired
initiationFeenumber · nullableRequired
durationDaysnumber · nullableRequired
The number of days the membership will be active for if the charge type is non-recurring
totalnumber · nullableRequired
additionalMemberFeenumber · nullableRequired
chargeTypestring · enumRequiredPossible values:
_linksobjectRequired
get/users/{userId}/memberships/{membershipSubscriptionId}
GET /apis/v2/users/{userId}/memberships/{membershipSubscriptionId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a MembershipSubscription
{
"id": "text",
"displayName": "text",
"type": "GLOBAL_MEMBER",
"status": "DRAFT",
"extendedStatus": "ACTIVE",
"mode": "PREVIEW",
"condition": "VALID",
"conditionUpdatedDate": "2026-01-01T00:00:00.000Z",
"createdDate": "2026-01-01T00:00:00.000Z",
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"cancellationRequestDate": "2026-01-01T00:00:00.000Z",
"lastChargeDate": "2026-01-01T00:00:00.000Z",
"nextChargeDate": "2026-01-01T00:00:00.000Z",
"lastGrantDate": "2026-01-01T00:00:00.000Z",
"nextGrantDate": "2026-01-01T00:00:00.000Z",
"billingCycleStart": "2026-01-01T00:00:00.000Z",
"billingCycleEnd": "2026-01-01T00:00:00.000Z",
"activePause": {
"id": "text",
"pauseStartDate": "2026-01-01T00:00:00.000Z",
"pauseEndDate": "2026-01-01T00:00:00.000Z",
"pauseDurationWeeks": 1,
"pauseFeePaid": 1,
"status": "PENDING",
"createdAt": "2026-01-01T00:00:00.000Z",
"membershipSubscription": {
"id": "text"
},
"_links": {}
},
"timezone": "text",
"price": 1,
"initiationFee": 1,
"durationDays": 1,
"oneTimeOption": {
"id": "text"
},
"total": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"fees": [
{
"name": "Credit Card Fee",
"percentage": 2.9,
"amount": 100
}
],
"additionalMemberFee": 1,
"chargeType": "FREE",
"member": {
"id": "text"
},
"membership": {
"id": "text"
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"order": {
"id": "text"
},
"summary": {
"total": 1,
"membershipPrice": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"fees": [
{
"name": "Credit Card Fee",
"percentage": 2.9,
"amount": 100
}
],
"messages": [
{
"code": "text",
"message": "text"
}
],
"billingCycleStart": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"initiationFee": 1,
"chargeType": "FREE"
},
"_links": {}
}patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
membershipSubscriptionIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Query parameters
expandstring[]OptionalExample:
["_links.membership"]Body
lastChargeDatestring · date-timeRequired
nextChargeDatestring · date-timeRequired
nextGrantDatestring · date-timeRequired
timezonestringRequired
The timezone used to display and calculate charge and grant dates for the subscription.
pricenumber · nullableRequired
Responses
200
Returns a MembershipSubscription
application/json
idstringRequired
displayNamestringRequired
typestring · enumRequiredPossible values:
statusstring · enumRequiredPossible values:
extendedStatusstring · enumRequiredPossible values:
modestring · enumRequiredPossible values:
conditionstring · enumRead-onlyRequiredPossible values:
conditionUpdatedDatestring · date-timeRead-onlyRequired
createdDatestring · date-timeRequired
startDatestring · date-timeRequired
endDatestring · date-timeRequired
cancellationRequestDatestring · date-timeRequired
lastChargeDatestring · date-timeRequired
nextChargeDatestring · date-timeRequired
lastGrantDatestring · date-time · nullableRead-onlyRequired
The last time the membership perks were granted to the user
nextGrantDatestring · date-timeRequired
billingCycleStartstring · date-timeRequired
billingCycleEndstring · date-timeRequired
timezonestringRequired
The timezone used to display and calculate charge and grant dates for the subscription.
pricenumber · nullableRequired
initiationFeenumber · nullableRequired
durationDaysnumber · nullableRequired
The number of days the membership will be active for if the charge type is non-recurring
totalnumber · nullableRequired
additionalMemberFeenumber · nullableRequired
chargeTypestring · enumRequiredPossible values:
_linksobjectRequired
patch/users/{userId}/memberships/{membershipSubscriptionId}
PATCH /apis/v2/users/{userId}/memberships/{membershipSubscriptionId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 160
{
"lastChargeDate": "2026-01-01T00:00:00.000Z",
"nextChargeDate": "2026-01-01T00:00:00.000Z",
"nextGrantDate": "2026-01-01T00:00:00.000Z",
"timezone": "text",
"price": 1
}200
Returns a MembershipSubscription
{
"id": "text",
"displayName": "text",
"type": "GLOBAL_MEMBER",
"status": "DRAFT",
"extendedStatus": "ACTIVE",
"mode": "PREVIEW",
"condition": "VALID",
"conditionUpdatedDate": "2026-01-01T00:00:00.000Z",
"createdDate": "2026-01-01T00:00:00.000Z",
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"cancellationRequestDate": "2026-01-01T00:00:00.000Z",
"lastChargeDate": "2026-01-01T00:00:00.000Z",
"nextChargeDate": "2026-01-01T00:00:00.000Z",
"lastGrantDate": "2026-01-01T00:00:00.000Z",
"nextGrantDate": "2026-01-01T00:00:00.000Z",
"billingCycleStart": "2026-01-01T00:00:00.000Z",
"billingCycleEnd": "2026-01-01T00:00:00.000Z",
"activePause": {
"id": "text",
"pauseStartDate": "2026-01-01T00:00:00.000Z",
"pauseEndDate": "2026-01-01T00:00:00.000Z",
"pauseDurationWeeks": 1,
"pauseFeePaid": 1,
"status": "PENDING",
"createdAt": "2026-01-01T00:00:00.000Z",
"membershipSubscription": {
"id": "text"
},
"_links": {}
},
"timezone": "text",
"price": 1,
"initiationFee": 1,
"durationDays": 1,
"oneTimeOption": {
"id": "text"
},
"total": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"fees": [
{
"name": "Credit Card Fee",
"percentage": 2.9,
"amount": 100
}
],
"additionalMemberFee": 1,
"chargeType": "FREE",
"member": {
"id": "text"
},
"membership": {
"id": "text"
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"order": {
"id": "text"
},
"summary": {
"total": 1,
"membershipPrice": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"fees": [
{
"name": "Credit Card Fee",
"percentage": 2.9,
"amount": 100
}
],
"messages": [
{
"code": "text",
"message": "text"
}
],
"billingCycleStart": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"initiationFee": 1,
"chargeType": "FREE"
},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
membershipSubscriptionIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Query parameters
expandstring[]OptionalExample:
["items._links.redemptions"]Responses
200
Returns a PackageCollection
application/json
_totalnumberRequired
get/users/{userId}/memberships/{membershipSubscriptionId}/packages
GET /apis/v2/users/{userId}/memberships/{membershipSubscriptionId}/packages HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a PackageCollection
{
"items": [
{
"id": "text",
"displayName": "text",
"displayNamePlural": "text",
"status": "ACTIVE",
"createdDate": "2026-01-01T00:00:00.000Z",
"expirationDate": "2026-01-01T00:00:00.000Z",
"items": {
"items": [
{
"id": "text",
"type": "BOOKING",
"displayName": "text",
"displayNamePlural": "text",
"totalItems": 1,
"constraints": {
"bookingEventSubtype": [
null
],
"bookingEventCustomType": "text",
"bookingEventCustomTypesMatchAny": [
"text"
],
"bookingEventTagsMatchAll": [
"text"
],
"bookingEventTagsMatchAny": [
"text"
],
"allowKids": true,
"bookingSessionPeriodTypeMatchAny": [
null
],
"bookingAreaSlugMatchAny": [
"text"
],
"bookingPodIdsMatchAny": [
"text"
]
},
"remainingItems": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"redemptions": {
"items": [
{
"id": "text",
"redemptionDate": "2026-01-01T00:00:00.000Z",
"item": 1,
"user": {
"id": "text"
},
"order": {
"id": "text"
},
"orderItem": {
"id": "text"
},
"cancelationDate": "2026-01-01T00:00:00.000Z",
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"template": {
"id": "text"
},
"order": {
"id": "text"
},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Query parameters
expandstring[]OptionalExample:
["items._links.membershipSubscription"]Responses
200
Returns a MembershipEnrollmentCollection
application/json
_totalnumberRequired
_linksobjectRequired
get/users/{userId}/enrollments
GET /apis/v2/users/{userId}/enrollments HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a MembershipEnrollmentCollection
{
"items": [
{
"id": "text",
"displayName": "text",
"type": "GLOBAL_MEMBER",
"user": {
"id": "text"
},
"creatorUser": {
"id": "text"
},
"membership": {
"id": "text"
},
"membershipSubscription": {
"id": "text"
},
"isOwner": true,
"createdDate": "2026-01-01T00:00:00.000Z",
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"customFee": 0,
"_links": {}
}
],
"_total": 1,
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
membershipEnrollmentIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200
Returns a MembershipSubscription
application/json
idstringRequired
displayNamestringRead-onlyRequired
typestring · enumRead-onlyRequiredPossible values:
isOwnerboolean · nullableRead-onlyRequired
createdDatestring · date-timeOptional
startDatestring · date-timeOptional
endDatestring · date-timeOptional
customFeenumberRequiredDefault:
0_linksobjectRequired
get/users/{userId}/enrollments/{membershipEnrollmentId}
GET /apis/v2/users/{userId}/enrollments/{membershipEnrollmentId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a MembershipSubscription
{
"id": "text",
"displayName": "text",
"type": "GLOBAL_MEMBER",
"user": {
"id": "text"
},
"creatorUser": {
"id": "text"
},
"membership": {
"id": "text"
},
"membershipSubscription": {
"id": "text"
},
"isOwner": true,
"createdDate": "2026-01-01T00:00:00.000Z",
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"customFee": 0,
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
membershipSubscriptionIdstringRequiredExample:
eff5a89e-b040-493d-ab9c-1f3a4763b451includeInactivebooleanRequired
userIdstringRequiredExample:
W2kubmCsuXS2AvyRw2NyyJ3CePl2Responses
200
Returns a membershipEnrollmentCollection
application/json
_totalnumberRequired
_linksobjectRequired
get/users/{userId}/memberships/{membershipSubscriptionId}/enrollments
GET /apis/v2/users/{userId}/memberships/{membershipSubscriptionId}/enrollments HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a membershipEnrollmentCollection
{
"items": [
{
"id": "text",
"displayName": "text",
"type": "GLOBAL_MEMBER",
"user": {
"id": "text"
},
"creatorUser": {
"id": "text"
},
"membership": {
"id": "text"
},
"membershipSubscription": {
"id": "text"
},
"isOwner": true,
"createdDate": "2026-01-01T00:00:00.000Z",
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"customFee": 0,
"_links": {}
}
],
"_total": 1,
"_links": {}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
membershipSubscriptionIdstringRequiredExample:
eff5a89e-b040-493d-ab9c-1f3a4763b451userIdstringRequiredExample:
W2kubmCsuXS2AvyRw2NyyJ3CePl2Body
idstringRequired
displayNamestringRead-onlyRequired
typestring · enumRead-onlyRequiredPossible values:
isOwnerboolean · nullableRead-onlyRequired
createdDatestring · date-timeOptional
startDatestring · date-timeOptional
endDatestring · date-timeOptional
customFeenumberRequiredDefault:
0_linksobjectRequired
Responses
200
Returns an UsersMembershipSubscription
application/json
idstringRequired
displayNamestringRead-onlyRequired
typestring · enumRead-onlyRequiredPossible values:
isOwnerboolean · nullableRead-onlyRequired
createdDatestring · date-timeOptional
startDatestring · date-timeOptional
endDatestring · date-timeOptional
customFeenumberRequiredDefault:
0_linksobjectRequired
422
Returns an error
application/json
post/users/{userId}/memberships/{membershipSubscriptionId}/enrollments
POST /apis/v2/users/{userId}/memberships/{membershipSubscriptionId}/enrollments HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 216
{
"id": "text",
"user": {
"id": "text"
},
"membershipSubscription": {
"id": "text"
},
"createdDate": "2026-01-01T00:00:00.000Z",
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"customFee": 0,
"_links": {}
}{
"id": "text",
"displayName": "text",
"type": "GLOBAL_MEMBER",
"user": {
"id": "text"
},
"creatorUser": {
"id": "text"
},
"membership": {
"id": "text"
},
"membershipSubscription": {
"id": "text"
},
"isOwner": true,
"createdDate": "2026-01-01T00:00:00.000Z",
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-01T00:00:00.000Z",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"customFee": 0,
"_links": {}
}patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
membershipSubscriptionIdstringRequiredExample:
eff5a89e-b040-493d-ab9c-1f3a4763b451userIdstringRequiredExample:
W2kubmCsuXS2AvyRw2NyyJ3CePl2Body
_totalnumberRequired
_linksobjectRequired
Responses
200
Returns an MembershipEnrollmentInvitationCollection
application/json
_totalnumberRequired
_linksobjectRequired
422
Returns an error
application/json
patch/users/{userId}/memberships/{membershipSubscriptionId}/invitations
PATCH /apis/v2/users/{userId}/memberships/{membershipSubscriptionId}/invitations HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70
{
"items": [
{
"inviteeEmail": "text",
"_links": {}
}
],
"_total": 1,
"_links": {}
}{
"items": [
{
"id": "text",
"status": "text",
"createdDate": "2026-01-01T00:00:00.000Z",
"acceptedDate": "2026-01-01T00:00:00.000Z",
"declinedDate": "2026-01-01T00:00:00.000Z",
"membershipSubscription": {},
"membership": {},
"inviteeEmail": "text",
"inviter": {},
"invitee": {},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}
],
"_total": 1,
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
membershipSubscriptionIdstringRequiredExample:
eff5a89e-b040-493d-ab9c-1f3a4763b451invitationIdstringRequiredExample:
feff5a88e-b040-ab9c-493d-1f3a4763b454userIdstringRequiredExample:
W2kubmCsuXS2AvyRw2NyyJ3CePl2Responses
200
Returns a MembershipEnrollmentInvitation
application/json
idstringRead-onlyRequired
statusstringRead-onlyRequired
createdDatestring · date-timeRead-onlyRequired
acceptedDatestring · date-timeRead-onlyRequired
declinedDatestring · date-timeRead-onlyRequired
membershipSubscriptionobjectRead-onlyRequired
membershipobjectRead-onlyRequired
inviteeEmailstringRequired
inviterobjectRead-onlyRequired
inviteeobjectRead-onlyRequired
_linksobjectRequired
get/users/{userId}/memberships/{membershipSubscriptionId}/invitations/{invitationId}
GET /apis/v2/users/{userId}/memberships/{membershipSubscriptionId}/invitations/{invitationId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a MembershipEnrollmentInvitation
{
"id": "text",
"status": "text",
"createdDate": "2026-01-01T00:00:00.000Z",
"acceptedDate": "2026-01-01T00:00:00.000Z",
"declinedDate": "2026-01-01T00:00:00.000Z",
"membershipSubscription": {},
"membership": {},
"inviteeEmail": "text",
"inviter": {},
"invitee": {},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
membershipSubscriptionIdstringRequiredExample:
eff5a89e-b040-493d-ab9c-1f3a4763b451invitationIdstringRequiredExample:
feff5a88e-b040-ab9c-493d-1f3a4763b454userIdstringRequiredExample:
W2kubmCsuXS2AvyRw2NyyJ3CePl2Body
idstringRead-onlyRequired
statusstringRead-onlyRequired
createdDatestring · date-timeRead-onlyRequired
acceptedDatestring · date-timeRead-onlyRequired
declinedDatestring · date-timeRead-onlyRequired
membershipSubscriptionobjectRead-onlyRequired
membershipobjectRead-onlyRequired
inviteeEmailstringRequired
inviterobjectRead-onlyRequired
inviteeobjectRead-onlyRequired
_linksobjectRequired
Responses
200
Returns a MembershipEnrollmentInvitation
application/json
idstringRead-onlyRequired
statusstringRead-onlyRequired
createdDatestring · date-timeRead-onlyRequired
acceptedDatestring · date-timeRead-onlyRequired
declinedDatestring · date-timeRead-onlyRequired
membershipSubscriptionobjectRead-onlyRequired
membershipobjectRead-onlyRequired
inviteeEmailstringRequired
inviterobjectRead-onlyRequired
inviteeobjectRead-onlyRequired
_linksobjectRequired
patch/users/{userId}/memberships/{membershipSubscriptionId}/invitations/{invitationId}
PATCH /apis/v2/users/{userId}/memberships/{membershipSubscriptionId}/invitations/{invitationId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35
{
"inviteeEmail": "text",
"_links": {}
}200
Returns a MembershipEnrollmentInvitation
{
"id": "text",
"status": "text",
"createdDate": "2026-01-01T00:00:00.000Z",
"acceptedDate": "2026-01-01T00:00:00.000Z",
"declinedDate": "2026-01-01T00:00:00.000Z",
"membershipSubscription": {},
"membership": {},
"inviteeEmail": "text",
"inviter": {},
"invitee": {},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
membershipEnrollmentIdstringRequiredExample:
1857358a-59e8-4944-8c48-3345c4375b43userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Body
typestring · enumRequiredPossible values:
reasonstringRequired
Responses
200
Returns an MembershipEnrollmentReactivation
application/json
typestring · enumRequiredPossible values:
reasonstringRequired
422
Returns an error
application/json
post/users/{userId}/enrollments/{membershipEnrollmentId}/reactivations
POST /apis/v2/users/{userId}/enrollments/{membershipEnrollmentId}/reactivations HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34
{
"type": "PREVIEW",
"reason": "text"
}{
"type": "PREVIEW",
"reason": "text",
"summary": {
"policy": "FREE_OF_CHARGE",
"reactivationTime": "2026-01-01T00:00:00.000Z",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
membershipEnrollmentIdstringRequiredExample:
1857358a-59e8-4944-8c48-3345c4375b43userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Body
typestring · enumRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
reasonstringRequired
extraMemberFeenumberRequired
immediatelybooleanRequired
Responses
200
Returns an EventSignupCancellation
application/json
typestring · enumRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
reasonstringRequired
extraMemberFeenumberRequired
immediatelybooleanRequired
422
Returns an error
application/json
post/users/{userId}/enrollments/{membershipEnrollmentId}/cancellation
POST /apis/v2/users/{userId}/enrollments/{membershipEnrollmentId}/cancellation HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 72
{
"type": "PREVIEW",
"reason": "text",
"extraMemberFee": 1,
"immediately": true
}{
"type": "PREVIEW",
"status": "DRAFT",
"reason": "text",
"extraMemberFee": 1,
"immediately": true,
"summary": {
"policy": "FREE_OF_CHARGE",
"cancellationTime": "2026-01-01T00:00:00.000Z",
"validUntilTime": "2026-01-01T00:00:00.000Z",
"cancellationFee": 1,
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"messages": [
{
"code": "text",
"message": "text"
}
]
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
membershipEnrollmentIdstringRequiredExample:
1857358a-59e8-4944-8c48-3345c4375b43userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Body
typestring · enumRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
durationWeeksnumberRequired
Duration of pause in weeks
pauseFeenumberRequired
Responses
200
Returns a MembershipEnrollmentPause
application/json
typestring · enumRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
durationWeeksnumberRequired
Duration of pause in weeks
pauseFeenumberRequired
422
Returns an error
application/json
post/users/{userId}/enrollments/{membershipEnrollmentId}/pause
POST /apis/v2/users/{userId}/enrollments/{membershipEnrollmentId}/pause HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49
{
"type": "PREVIEW",
"durationWeeks": 1,
"pauseFee": 1
}{
"type": "PREVIEW",
"status": "DRAFT",
"durationWeeks": 1,
"pauseFee": 1,
"summary": {
"pauseStartDate": "2026-01-01T00:00:00.000Z",
"pauseEndDate": "2026-01-01T00:00:00.000Z",
"pauseDurationWeeks": 1,
"pauseFee": 1,
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"messages": [
{
"code": "text",
"message": "text"
}
]
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
membershipEnrollmentIdstringRequiredExample:
1857358a-59e8-4944-8c48-3345c4375b43userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Body
typestring · enumRequiredPossible values:
Responses
200
Returns a MembershipEnrollmentUnpause
application/json
typestring · enumRequiredPossible values:
422
Returns an error
application/json
post/users/{userId}/enrollments/{membershipEnrollmentId}/unpause
POST /apis/v2/users/{userId}/enrollments/{membershipEnrollmentId}/unpause HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"type": "PREVIEW"
}{
"type": "PREVIEW",
"summary": {
"unpauseTime": "2026-01-01T00:00:00.000Z",
"actualPauseDurationWeeks": 1,
"nextChargeDate": "2026-01-01T00:00:00.000Z",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
searchstringOptionalExample:
matiincludePristinebooleanOptional
Applicable only if areaId is specified.
memberSinceMinstring · date-timeOptionalExample:
2022-01-01T00:00:00.000ZmemberSinceMaxstring · date-timeOptionalExample:
2024-01-01T00:00:00.000ZtenureMinstring · date-timeOptionalExample:
2022-01-01T00:00:00.000ZtenureMaxstring · date-timeOptionalExample:
2024-01-01T23:59:59.999Zconditionstring[]OptionalExample:
["GRACE"]pagenumberOptionalExample:
1ippnumberOptionalExample:
30strictLocationbooleanOptional
If true, do not bypass location filters for exact email/full-name searches.
expandstring[]OptionalExample:
["items._links.phoneNumber","items._links.paymentMethod","items._links.profile"]sortstringOptionalExample:
If not set, sort will be defaulted as fullName (ASC)
-fullNamerolestring[]OptionalExample:
["COACH"]membershipIdstring[]OptionalExample:
["home-pod-nyc"]membershipAreaIdstring[]OptionalExample:
["les","w37"]areaIdstring[]OptionalExample:
["les","w37"]userIdstring[]OptionalExample:
["userId1","userId2"]Responses
200
Returns a UserCollection
application/json
get/users
GET /apis/v2/users HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a UserCollection
{
"items": [
{
"id": "text",
"email": "name@gmail.com",
"firstName": "text",
"lastName": "text",
"description": "text",
"notes": {
"id": "text"
},
"phoneNumberPreview": "text",
"phoneNumber": {
"id": "text"
},
"roles": [
"ADMIN"
],
"rolesAreas": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"flags": [
"NEW"
],
"paymentMethod": {
"id": "text"
},
"paymentElements": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"freeQuickReplays": 1,
"picture": {
"id": "text"
},
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"favoriteReplays": {},
"profile": {
"id": "text"
},
"coachProfile": {
"id": "text"
},
"qrCode": {
"id": "text"
},
"membershipEnrollment": {
"id": "text"
},
"ratings": {
"_total": 1
},
"securityPicture": {
"id": "text"
},
"chat": {
"id": "text"
},
"segmentation": {
"id": "text"
},
"_links": {}
}
],
"_pagination": {
"page": 1,
"ipp": 1,
"count": 1,
"total": 1
},
"_links": {
"self": {
"href": "text"
}
}
}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
utm_locationstringOptionalExample:
lesBody
idstringRead-onlyRequired
emailstring · emailRequired
passwordstringOptional
Minimum requirements: 6 characters long, at least 1 number.
firstNamestringOptional
lastNamestringOptional
genderstringOptional
birthdaystring · date-timeOptional
emailMarketingOptInbooleanOptional
smsMarketingOptInbooleanOptional
phoneVerificationSessionIdstringOptional
Phone verification session ID from the signup phone verification flow. Required when the tenant has phone number verification enabled on signup.
Responses
201
Returns the UserSignup
application/json
idstringRead-onlyRequired
emailstring · emailRequired
passwordstringOptional
Minimum requirements: 6 characters long, at least 1 number.
firstNamestringOptional
lastNamestringOptional
genderstringOptional
birthdaystring · date-timeOptional
emailMarketingOptInbooleanOptional
smsMarketingOptInbooleanOptional
phoneVerificationSessionIdstringOptional
Phone verification session ID from the signup phone verification flow. Required when the tenant has phone number verification enabled on signup.
422
Returns an ErrorDto in case of validation errors or failures.
Possible error codes are:US001: The email address is not valid.US002: The email address is already in use.US003: The password does not meet the minimum requirements.US004: Birthday is required.US005: Gender is required.US006: Gender is too long. (Max 25 characters)US007: Must be at least {{minimumAge}} years old to sign up.US008: You must accept the liability waiver to sign up.US009: Invalid agreement IDs: {{invalidAgreementIds}}
post/users
POST /apis/v2/users HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 308
{
"email": "name@gmail.com",
"password": "text",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"emailMarketingOptIn": true,
"smsMarketingOptIn": true,
"acceptedAgreements": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"phoneVerificationSessionId": "text"
}{
"id": "text",
"email": "name@gmail.com",
"password": "text",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"emailMarketingOptIn": true,
"smsMarketingOptIn": true,
"requiredAgreements": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"phoneVerificationSessionId": "text",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200
Disconnect the DUPR account from the user
No content
post/users/{userId}/dupr/logout
POST /apis/v2/users/{userId}/dupr/logout HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Disconnect the DUPR account from the user
No content
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
expandstring[]OptionalExample:
["_links.phoneNumber","_links.paymentMethod","_links.profile"]Responses
200
Returns the logged in User
application/json
idstringRead-onlyRequired
emailstring · emailRead-onlyRequired
firstNamestringOptional
lastNamestringOptional
descriptionstringRequired
phoneNumberPreviewstringRead-onlyOptional
membershipTypestring · enumRead-onlyRequiredDeprecatedPossible values:
membershipBookingHorizonDaysnumberRead-onlyOptionalDeprecated
freeQuickReplaysnumberOptional
genderstringOptional
birthdaystring · date-timeOptional
favoriteReplaysobjectRead-onlyRequired
_linksobjectRequired
get/users/current
GET /apis/v2/users/current HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns the logged in User
{
"id": "text",
"email": "name@gmail.com",
"firstName": "text",
"lastName": "text",
"description": "text",
"notes": {
"id": "text"
},
"phoneNumberPreview": "text",
"phoneNumber": {
"id": "text"
},
"roles": [
"ADMIN"
],
"rolesAreas": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"flags": [
"NEW"
],
"paymentMethod": {
"id": "text"
},
"paymentElements": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"freeQuickReplays": 1,
"picture": {
"id": "text"
},
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"favoriteReplays": {},
"profile": {
"id": "text"
},
"coachProfile": {
"id": "text"
},
"qrCode": {
"id": "text"
},
"membershipEnrollment": {
"id": "text"
},
"ratings": {
"_total": 1
},
"securityPicture": {
"id": "text"
},
"chat": {
"id": "text"
},
"segmentation": {
"id": "text"
},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Query parameters
expandstring[]OptionalExample:
["_links.phoneNumber","_links.paymentMethod","_links.profile","_links.coachProfile","_links.picture"]Responses
200
Returns a User
application/json
idstringRead-onlyRequired
emailstring · emailRead-onlyRequired
firstNamestringOptional
lastNamestringOptional
descriptionstringRequired
phoneNumberPreviewstringRead-onlyOptional
membershipTypestring · enumRead-onlyRequiredDeprecatedPossible values:
membershipBookingHorizonDaysnumberRead-onlyOptionalDeprecated
freeQuickReplaysnumberOptional
genderstringOptional
birthdaystring · date-timeOptional
favoriteReplaysobjectRead-onlyRequired
_linksobjectRequired
get/users/{userId}
GET /apis/v2/users/{userId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a User
{
"id": "text",
"email": "name@gmail.com",
"firstName": "text",
"lastName": "text",
"description": "text",
"notes": {
"id": "text"
},
"phoneNumberPreview": "text",
"phoneNumber": {
"id": "text"
},
"roles": [
"ADMIN"
],
"rolesAreas": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"flags": [
"NEW"
],
"paymentMethod": {
"id": "text"
},
"paymentElements": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"freeQuickReplays": 1,
"picture": {
"id": "text"
},
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"favoriteReplays": {},
"profile": {
"id": "text"
},
"coachProfile": {
"id": "text"
},
"qrCode": {
"id": "text"
},
"membershipEnrollment": {
"id": "text"
},
"ratings": {
"_total": 1
},
"securityPicture": {
"id": "text"
},
"chat": {
"id": "text"
},
"segmentation": {
"id": "text"
},
"_links": {}
}delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200
Returns the deleted User
application/json
idstringRead-onlyRequired
emailstring · emailRead-onlyRequired
firstNamestringOptional
lastNamestringOptional
descriptionstringRequired
phoneNumberPreviewstringRead-onlyOptional
membershipTypestring · enumRead-onlyRequiredDeprecatedPossible values:
membershipBookingHorizonDaysnumberRead-onlyOptionalDeprecated
freeQuickReplaysnumberOptional
genderstringOptional
birthdaystring · date-timeOptional
favoriteReplaysobjectRead-onlyRequired
_linksobjectRequired
delete/users/{userId}
DELETE /apis/v2/users/{userId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns the deleted User
{
"id": "text",
"email": "name@gmail.com",
"firstName": "text",
"lastName": "text",
"description": "text",
"notes": {
"id": "text"
},
"phoneNumberPreview": "text",
"phoneNumber": {
"id": "text"
},
"roles": [
"ADMIN"
],
"rolesAreas": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"flags": [
"NEW"
],
"paymentMethod": {
"id": "text"
},
"paymentElements": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"freeQuickReplays": 1,
"picture": {
"id": "text"
},
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"favoriteReplays": {},
"profile": {
"id": "text"
},
"coachProfile": {
"id": "text"
},
"qrCode": {
"id": "text"
},
"membershipEnrollment": {
"id": "text"
},
"ratings": {
"_total": 1
},
"securityPicture": {
"id": "text"
},
"chat": {
"id": "text"
},
"segmentation": {
"id": "text"
},
"_links": {}
}patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Query parameters
expandstring[]OptionalExample:
["_links.phoneNumber"]Body
emailstring · emailRead-onlyRequired
firstNamestringOptional
lastNamestringOptional
descriptionstringRequired
membershipTypestring · enumRead-onlyRequiredDeprecatedPossible values:
freeQuickReplaysnumberOptional
genderstringOptional
birthdaystring · date-timeOptional
Responses
200
Returns a User
application/json
idstringRead-onlyRequired
emailstring · emailRead-onlyRequired
firstNamestringOptional
lastNamestringOptional
descriptionstringRequired
phoneNumberPreviewstringRead-onlyOptional
membershipTypestring · enumRead-onlyRequiredDeprecatedPossible values:
membershipBookingHorizonDaysnumberRead-onlyOptionalDeprecated
freeQuickReplaysnumberOptional
genderstringOptional
birthdaystring · date-timeOptional
favoriteReplaysobjectRead-onlyRequired
_linksobjectRequired
422
Returns an Error
application/json
patch/users/{userId}
PATCH /apis/v2/users/{userId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 301
{
"firstName": "text",
"lastName": "text",
"description": "text",
"roles": [
"ADMIN"
],
"rolesAreas": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"flags": [
"NEW"
],
"freeQuickReplays": 1,
"picture": {
"id": "text"
},
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"securityPicture": {
"id": "text"
}
}{
"id": "text",
"email": "name@gmail.com",
"firstName": "text",
"lastName": "text",
"description": "text",
"notes": {
"id": "text"
},
"phoneNumberPreview": "text",
"phoneNumber": {
"id": "text"
},
"roles": [
"ADMIN"
],
"rolesAreas": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"flags": [
"NEW"
],
"paymentMethod": {
"id": "text"
},
"paymentElements": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"freeQuickReplays": 1,
"picture": {
"id": "text"
},
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"favoriteReplays": {},
"profile": {
"id": "text"
},
"coachProfile": {
"id": "text"
},
"qrCode": {
"id": "text"
},
"membershipEnrollment": {
"id": "text"
},
"ratings": {
"_total": 1
},
"securityPicture": {
"id": "text"
},
"chat": {
"id": "text"
},
"segmentation": {
"id": "text"
},
"_links": {}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200Success
No content
post/users/{userId}/activation
POST /apis/v2/users/{userId}/activation HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
No content
delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200Success
No content
delete/users/{userId}/activation
DELETE /apis/v2/users/{userId}/activation HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
No content
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Query parameters
pagenumberOptionalExample:
1ippnumberOptionalExample:
30expandstring[]OptionalExample:
["items._links.replay","items._links.event","items._links.event._links.invitations","items._links.event._links.invitations.items._links.inviteeProfile"]Responses
200
Returns a EventReplayPaginatedCollection
application/json
itemsstring[]Required
_totalnumberRequiredDeprecated
get/users/{userId}/favorite-replays
GET /apis/v2/users/{userId}/favorite-replays HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a EventReplayPaginatedCollection
{
"items": [
"text"
],
"_pagination": {
"page": 1,
"ipp": 1,
"count": 1,
"total": 1
},
"_links": {
"self": {
"href": "text"
}
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
201Success
No content
post/users/{userId}/coach-profile
POST /apis/v2/users/{userId}/coach-profile HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
201Success
No content
delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200Success
No content
delete/users/{userId}/coach-profile
DELETE /apis/v2/users/{userId}/coach-profile HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
No content
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Query parameters
Responses
200
Returns a UserContactCollection
application/json
_totalnumberRequired
get/users/{userId}/contacts
GET /apis/v2/users/{userId}/contacts HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a UserContactCollection
{
"items": [
{
"id": "text",
"type": "EMAIL",
"email": "text",
"phoneNumber": "text"
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Query parameters
pagenumberOptionalExample:
1ippnumberOptionalExample:
30Responses
200
Returns a VirtualCreditsTransactionsCollection
application/json
_totalnumberRequiredDeprecated
get/users/{userId}/virtual-credits-transactions
GET /apis/v2/users/{userId}/virtual-credits-transactions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a VirtualCreditsTransactionsCollection
{
"items": [
{
"id": "text",
"order": {
"id": "text"
},
"user": {
"id": "text"
},
"createdAt": "2026-01-01T00:00:00.000Z",
"amountType": "INCOME",
"amount": 1,
"balance": 1,
"source": "BOOKING",
"reason": "text",
"updatedBy": {
"id": "text"
},
"_links": {}
}
],
"_pagination": {
"page": 1,
"ipp": 1,
"count": 1,
"total": 1
},
"_links": {
"self": {
"href": "text"
}
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Body
idstringRead-onlyRequired
createdAtstring · date-timeRead-onlyRequired
amountTypestring · enumRequiredPossible values:
amountnumberRequired
balancenumberRead-onlyRequired
sourcestring · enumRead-onlyRequiredPossible values:
reasonstringOptional
_linksobjectRequired
Responses
200
Returns a User with updated virtual credits
application/json
idstringRead-onlyRequired
emailstring · emailRead-onlyRequired
firstNamestringOptional
lastNamestringOptional
descriptionstringRequired
phoneNumberPreviewstringRead-onlyOptional
membershipTypestring · enumRead-onlyRequiredDeprecatedPossible values:
membershipBookingHorizonDaysnumberRead-onlyOptionalDeprecated
freeQuickReplaysnumberOptional
genderstringOptional
birthdaystring · date-timeOptional
favoriteReplaysobjectRead-onlyRequired
_linksobjectRequired
post/users/{userId}/virtual-credits-transactions
POST /apis/v2/users/{userId}/virtual-credits-transactions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 62
{
"amountType": "INCOME",
"amount": 1,
"reason": "text",
"_links": {}
}200
Returns a User with updated virtual credits
{
"id": "text",
"email": "name@gmail.com",
"firstName": "text",
"lastName": "text",
"description": "text",
"notes": {
"id": "text"
},
"phoneNumberPreview": "text",
"phoneNumber": {
"id": "text"
},
"roles": [
"ADMIN"
],
"rolesAreas": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"flags": [
"NEW"
],
"paymentMethod": {
"id": "text"
},
"paymentElements": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"freeQuickReplays": 1,
"picture": {
"id": "text"
},
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"favoriteReplays": {},
"profile": {
"id": "text"
},
"coachProfile": {
"id": "text"
},
"qrCode": {
"id": "text"
},
"membershipEnrollment": {
"id": "text"
},
"ratings": {
"_total": 1
},
"securityPicture": {
"id": "text"
},
"chat": {
"id": "text"
},
"segmentation": {
"id": "text"
},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
currentResponses
200
Get the user preferences
No content
get/users/{userId}/preferences
GET /apis/v2/users/{userId}/preferences HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Get the user preferences
No content
patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
currentBody
showUserNameOnEventsbooleanRequired
showUserRatingOnEventsbooleanRequired
chatOptInbooleanRequired
emailMarketingOptInbooleanRequired
smsMarketingOptInbooleanRequired
Responses
200
Update the user preferences
No content
patch/users/{userId}/preferences
PATCH /apis/v2/users/{userId}/preferences HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 128
{
"showUserNameOnEvents": true,
"showUserRatingOnEvents": true,
"chatOptIn": true,
"emailMarketingOptIn": true,
"smsMarketingOptIn": true
}200
Update the user preferences
No content
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200
Returns a FrontChat
application/json
hashstringRequired
get/users/{userId}/frontchat
GET /apis/v2/users/{userId}/frontchat HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a FrontChat
{
"hash": "text"
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
currentResponses
200
Get the UserChat
application/json
idstringRead-onlyRequired
statusstring · enumRequiredPossible values:
handlestringRead-onlyRequired
displayNamestringRead-onlyRequired
unreadMessagesnumberRead-onlyRequired
errorsstring[] · nullableRead-onlyRequired
get/users/{userId}/chat
GET /apis/v2/users/{userId}/chat HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Get the UserChat
{
"id": "text",
"status": "INACTIVE",
"handle": "text",
"displayName": "text",
"unreadMessages": 1,
"avatar": {
"id": "text",
"small": {
"href": "text"
},
"medium": {
"href": "text"
},
"large": {
"href": "text"
},
"_links": {
"self": {
"href": "text"
}
}
},
"errors": [
"text"
]
}patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
currentBody
statusstring · enumRequiredPossible values:
termsAgreedboolean · nullableWrite-onlyRequired
An optional parameter to tell the User is agreeing the "Terms" along with the chat activation request.
Responses
200
Update the UserChat
application/json
idstringRead-onlyRequired
statusstring · enumRequiredPossible values:
handlestringRead-onlyRequired
displayNamestringRead-onlyRequired
unreadMessagesnumberRead-onlyRequired
errorsstring[] · nullableRead-onlyRequired
422
Possible error codes are:UC001: User phone number is required.UC002: Terms of Service agreement is required.
application/json
patch/users/{userId}/chat
PATCH /apis/v2/users/{userId}/chat HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"status": "INACTIVE",
"termsAgreed": true
}{
"id": "text",
"status": "INACTIVE",
"handle": "text",
"displayName": "text",
"unreadMessages": 1,
"avatar": {
"id": "text",
"small": {
"href": "text"
},
"medium": {
"href": "text"
},
"large": {
"href": "text"
},
"_links": {
"self": {
"href": "text"
}
}
},
"errors": [
"text"
]
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
areaIdstringRequiredExample:
lesuserIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200
Returns a UserQuotasBookingArea
application/json
selectableUnitstring · enumRequiredPossible values:
allowMultiReservationBookingbooleanRequired
minDurationHoursnumber · enumRequiredPossible values:
The default duration is 0.5.
maxDurationHoursnumber · nullableRequired
null means no limit.
maxFreeOffPeakHoursnumberRequired
The default limit is 12.
maxFutureRegularReservationsnumber · nullableRequiredDeprecated
null means no limit.
remainingFutureRegularReservationsnumber · nullableRequiredDeprecated
null means no limit, so no remaining value is possuble to calculate.
maxFuturePrivateReservationsnumber · nullableRequired
null means no limit.
remainingFuturePrivateReservationsnumber · nullableRequired
null means no limit, so no remaining value is possuble to calculate.
get/users/{userId}/quotas/booking/{areaId}
GET /apis/v2/users/{userId}/quotas/booking/{areaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a UserQuotasBookingArea
{
"selectableUnit": "HOUR",
"allowMultiReservationBooking": true,
"minDurationHours": 0.5,
"maxDurationHours": 1,
"maxFreeOffPeakHours": 1,
"maxFuturePrivateReservations": 1,
"remainingFuturePrivateReservations": 1,
"remainingPrivateReservationsByDay": {
"items": [
{
"isoDate": "2014-09-18",
"remainingPrivateReservations": 1
}
]
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
areaIdstringRequiredExample:
lesuserIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200
Returns a UserBookingSettingsDto
application/json
strategystring · enumRequiredPossible values:
get/users/{userId}/settings/booking/{areaId}
GET /apis/v2/users/{userId}/settings/booking/{areaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a UserBookingSettingsDto
{
"strategy": "spot+",
"quotas": {
"selectableUnit": "HOUR",
"allowMultiReservationBooking": true,
"minDurationHours": 0.5,
"maxDurationHours": 1,
"maxFreeOffPeakHours": 1,
"maxFuturePrivateReservations": 1,
"remainingFuturePrivateReservations": 1,
"remainingPrivateReservationsByDay": {
"items": [
{
"isoDate": "2014-09-18",
"remainingPrivateReservations": 1
}
]
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
ZOlaEGIHhDdqfx1cBMfZuXb7nbA2Responses
200
Get the QR code urls for the user
No content
get/users/{userId}/qr-code
GET /apis/v2/users/{userId}/qr-code HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Get the QR code urls for the user
No content
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
sizestringRequiredExample:
smalluserIdstringRequiredExample:
ZOlaEGIHhDdqfx1cBMfZuXb7nbA2Responses
200
Get the QR code PNG image for the user
No content
get/users/{userId}/qr-code-image/{size}
GET /apis/v2/users/{userId}/qr-code-image/{size} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Get the QR code PNG image for the user
No content
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200
Returns a UserKidCollection
application/json
_totalnumberRequired
get/users/{userId}/kids
GET /apis/v2/users/{userId}/kids HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a UserKidCollection
{
"items": [
{
"id": "text",
"user": {
"id": "text"
},
"firstName": "text",
"lastName": "text",
"emergencyContactName": "text",
"emergencyContactPhoneNumber": "text",
"selfDismissal": true,
"pickupAuthorization": "text",
"allergies": "text",
"specialInstructions": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"requiredAgreements": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
}
],
"_total": 1
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Query parameters
utm_locationstringRequiredExample:
lesBody
idstringRequired
firstNamestringRequired
lastNamestringRequired
emergencyContactNamestringOptional
emergencyContactPhoneNumberstringOptional
selfDismissalbooleanOptional
pickupAuthorizationstringOptional
allergiesstringOptional
specialInstructionsstringOptional
genderstringOptional
birthdaystring · date-timeOptional
waiverAcceptedboolean · nullableRequiredDeprecated
Responses
201
Returns a UserKid
application/json
idstringRequired
firstNamestringRequired
lastNamestringRequired
emergencyContactNamestringOptional
emergencyContactPhoneNumberstringOptional
selfDismissalbooleanOptional
pickupAuthorizationstringOptional
allergiesstringOptional
specialInstructionsstringOptional
genderstringOptional
birthdaystring · date-timeOptional
waiverAcceptedboolean · nullableRequiredDeprecated
post/users/{userId}/kids
POST /apis/v2/users/{userId}/kids?utm_location=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 375
{
"id": "text",
"user": {
"id": "text"
},
"firstName": "text",
"lastName": "text",
"emergencyContactName": "text",
"emergencyContactPhoneNumber": "text",
"selfDismissal": true,
"pickupAuthorization": "text",
"allergies": "text",
"specialInstructions": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"acceptedAgreements": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}
}201
Returns a UserKid
{
"id": "text",
"user": {
"id": "text"
},
"firstName": "text",
"lastName": "text",
"emergencyContactName": "text",
"emergencyContactPhoneNumber": "text",
"selfDismissal": true,
"pickupAuthorization": "text",
"allergies": "text",
"specialInstructions": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"requiredAgreements": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2kidIdstringRequiredExample:
011e86e0-7765-43f2-b700-b05a4b2d30edResponses
201
Returns a UserKid
application/json
idstringRequired
firstNamestringRequired
lastNamestringRequired
emergencyContactNamestringOptional
emergencyContactPhoneNumberstringOptional
selfDismissalbooleanOptional
pickupAuthorizationstringOptional
allergiesstringOptional
specialInstructionsstringOptional
genderstringOptional
birthdaystring · date-timeOptional
waiverAcceptedboolean · nullableRequiredDeprecated
get/users/{userId}/kids/{kidId}
GET /apis/v2/users/{userId}/kids/{kidId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
201
Returns a UserKid
{
"id": "text",
"user": {
"id": "text"
},
"firstName": "text",
"lastName": "text",
"emergencyContactName": "text",
"emergencyContactPhoneNumber": "text",
"selfDismissal": true,
"pickupAuthorization": "text",
"allergies": "text",
"specialInstructions": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"requiredAgreements": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
}delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2kidIdstringRequiredExample:
011e86e0-7765-43f2-b700-b05a4b2d30edResponses
200
Returns a UserKid
application/json
idstringRequired
firstNamestringRequired
lastNamestringRequired
emergencyContactNamestringOptional
emergencyContactPhoneNumberstringOptional
selfDismissalbooleanOptional
pickupAuthorizationstringOptional
allergiesstringOptional
specialInstructionsstringOptional
genderstringOptional
birthdaystring · date-timeOptional
waiverAcceptedboolean · nullableRequiredDeprecated
delete/users/{userId}/kids/{kidId}
DELETE /apis/v2/users/{userId}/kids/{kidId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a UserKid
{
"id": "text",
"user": {
"id": "text"
},
"firstName": "text",
"lastName": "text",
"emergencyContactName": "text",
"emergencyContactPhoneNumber": "text",
"selfDismissal": true,
"pickupAuthorization": "text",
"allergies": "text",
"specialInstructions": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"requiredAgreements": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
}patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2kidIdstringRequiredExample:
011e86e0-7765-43f2-b700-b05a4b2d30edBody
idstringRequired
firstNamestringRequired
lastNamestringRequired
emergencyContactNamestringOptional
emergencyContactPhoneNumberstringOptional
selfDismissalbooleanOptional
pickupAuthorizationstringOptional
allergiesstringOptional
specialInstructionsstringOptional
genderstringOptional
birthdaystring · date-timeOptional
waiverAcceptedboolean · nullableRequiredDeprecated
Responses
200
Returns a UserKid
application/json
idstringRequired
firstNamestringRequired
lastNamestringRequired
emergencyContactNamestringOptional
emergencyContactPhoneNumberstringOptional
selfDismissalbooleanOptional
pickupAuthorizationstringOptional
allergiesstringOptional
specialInstructionsstringOptional
genderstringOptional
birthdaystring · date-timeOptional
waiverAcceptedboolean · nullableRequiredDeprecated
patch/users/{userId}/kids/{kidId}
PATCH /apis/v2/users/{userId}/kids/{kidId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 375
{
"id": "text",
"user": {
"id": "text"
},
"firstName": "text",
"lastName": "text",
"emergencyContactName": "text",
"emergencyContactPhoneNumber": "text",
"selfDismissal": true,
"pickupAuthorization": "text",
"allergies": "text",
"specialInstructions": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"acceptedAgreements": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}
}200
Returns a UserKid
{
"id": "text",
"user": {
"id": "text"
},
"firstName": "text",
"lastName": "text",
"emergencyContactName": "text",
"emergencyContactPhoneNumber": "text",
"selfDismissal": true,
"pickupAuthorization": "text",
"allergies": "text",
"specialInstructions": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"requiredAgreements": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
kidIdstringRequiredExample:
011e86e0-7765-43f2-b700-b05a4b2d30eduserIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200
Returns an EventInvitationCollection
application/json
_totalnumberRequired
get/users/{userId}/kids/{kidId}/invitations
GET /apis/v2/users/{userId}/kids/{kidId}/invitations HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns an EventInvitationCollection
{
"items": [
{
"id": "text",
"event": {
"id": "text"
},
"invitation": {
"id": "text"
},
"messages": [
{
"code": "text",
"message": "text"
}
],
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
ZOlaEGIHhDdqfx1cBMfZuXb7nbA2Responses
200
Retrieve UserSegmentation info.
No content
get/users/{userId}/segmentation
GET /apis/v2/users/{userId}/segmentation HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Retrieve UserSegmentation info.
No content
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Query parameters
onlyLatestbooleanOptionalExample:
Return only the latest agreements for each type and area, regardless of its status
falseareaIdstring[]OptionalExample:
["les","w37"]expandstring[]OptionalExample:
["items._links.agreement"]Responses
200
Returns a UserAgreementCollection
application/json
_totalnumberRequired
get/users/{userId}/agreements
GET /apis/v2/users/{userId}/agreements HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a UserAgreementCollection
{
"items": [
{
"id": "text",
"type": "TERMS_OF_SERVICE",
"status": "PENDING",
"agreementReleaseTime": "2026-01-01T00:00:00.000Z",
"agreementTime": "2026-01-01T00:00:00.000Z",
"agreedBy": {},
"area": {},
"agreement": {},
"kid": {},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Body
idstringRead-onlyRequired
typestring · enumRequiredPossible values:
statusstring · enumRequiredPossible values:
agreementReleaseTimestring · date-timeRead-onlyRequired
agreementTimestring · date-timeRead-onlyRequired
agreedByobjectRead-onlyRequired
areaobjectRequired
agreementobjectRead-onlyRequired
kidobjectRequired
_linksobjectRequired
Responses
201
Returns a UserAgreement
application/json
idstringRead-onlyRequired
typestring · enumRequiredPossible values:
statusstring · enumRequiredPossible values:
agreementReleaseTimestring · date-timeRead-onlyRequired
agreementTimestring · date-timeRead-onlyRequired
agreedByobjectRead-onlyRequired
areaobjectRequired
agreementobjectRead-onlyRequired
kidobjectRequired
_linksobjectRequired
post/users/{userId}/agreements
POST /apis/v2/users/{userId}/agreements HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77
{
"type": "TERMS_OF_SERVICE",
"status": "PENDING",
"area": {},
"kid": {},
"_links": {}
}201
Returns a UserAgreement
{
"id": "text",
"type": "TERMS_OF_SERVICE",
"status": "PENDING",
"agreementReleaseTime": "2026-01-01T00:00:00.000Z",
"agreementTime": "2026-01-01T00:00:00.000Z",
"agreedBy": {},
"area": {},
"agreement": {},
"kid": {},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Query parameters
areaIdstringOptionalExample:
lesResponses
200
Returns a UserAgreementCollection
application/json
_totalnumberRequired
404
Unable to fetch the required user agreements.
get/users/{userId}/agreements/required
GET /apis/v2/users/{userId}/agreements/required HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"items": [
{
"id": "text",
"type": "TERMS_OF_SERVICE",
"status": "PENDING",
"agreementReleaseTime": "2026-01-01T00:00:00.000Z",
"agreementTime": "2026-01-01T00:00:00.000Z",
"agreedBy": {},
"area": {},
"agreement": {},
"kid": {},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200
Returns the logged in User FeatureFlags
application/json
_totalnumberRequired
get/users/current/feature-flags
GET /apis/v2/users/current/feature-flags HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns the logged in User FeatureFlags
{
"items": [
{
"id": "text",
"enabled": true,
"config": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
featureFlagIdstringRequiredExample:
some-feature-flag-idResponses
200
Returns the logged in User FeatureFlag
application/json
idstringRequired
enabledbooleanRequired
configobjectOptional
404
Feature flag not found
get/users/current/feature-flags/{featureFlagId}
GET /apis/v2/users/current/feature-flags/{featureFlagId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "text",
"enabled": true,
"config": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200
Returns the given User FeatureFlags
application/json
_totalnumberRequired
403
Forbidden
404
User not found
get/users/{userId}/feature-flags
GET /apis/v2/users/{userId}/feature-flags HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"items": [
{
"id": "text",
"enabled": true,
"config": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
featureFlagIdstringRequiredExample:
some-feature-flag-iduserIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200
Returns the logged in User FeatureFlag
application/json
idstringRequired
enabledbooleanRequired
configobjectOptional
403
Forbidden
404
Feature flag not found
get/users/{userId}/feature-flags/{featureFlagId}
GET /apis/v2/users/{userId}/feature-flags/{featureFlagId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "text",
"enabled": true,
"config": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200
Returns a UserPhoneNumber
application/json
phoneNumberstringRequired
verificationCodestringWrite-onlyOptional
recaptchaTokenstringWrite-onlyOptional
verificationIdstringWrite-onlyOptional
verificationCodeExpirationstring · date-timeRead-onlyOptional
statusstring · enumRead-onlyRequiredPossible values:
smsMarketingOptInbooleanOptional
get/users/{userId}/phone-number
GET /apis/v2/users/{userId}/phone-number HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a UserPhoneNumber
{
"phoneNumber": "text",
"verificationCodeExpiration": "2026-01-01T00:00:00.000Z",
"status": "VERIFIED",
"smsMarketingOptIn": true,
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {
"self": {
"href": "text"
}
}
}Update `User`'s phone number. It's a two-steps process: first the `phoneNumber` is sent alone, then the pair `phoneNumber` + `verificationCode`.
put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Body
phoneNumberstringRequired
verificationCodestringWrite-onlyOptional
recaptchaTokenstringWrite-onlyOptional
verificationIdstringWrite-onlyOptional
verificationCodeExpirationstring · date-timeRead-onlyOptional
statusstring · enumRead-onlyRequiredPossible values:
smsMarketingOptInbooleanOptional
Responses
200
Returns the updated UserPhoneNumberDto
application/json
phoneNumberstringRequired
verificationCodestringWrite-onlyOptional
recaptchaTokenstringWrite-onlyOptional
verificationIdstringWrite-onlyOptional
verificationCodeExpirationstring · date-timeRead-onlyOptional
statusstring · enumRead-onlyRequiredPossible values:
smsMarketingOptInbooleanOptional
422
Returns an ErrorDto in case of validation errors or failures.
Possible error codes are:PN001: Invalid phone number.PN002: The phone number is already taken by another account.PN003: Invalid verification code.PN004: Invalid recaptcha verification.PN005: Recaptcha token expired.PN006: Too many phone verification attempts for the same phone number, please come back later.
put/users/{userId}/phone-number
PUT /apis/v2/users/{userId}/phone-number HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 155
{
"phoneNumber": "text",
"verificationCode": "text",
"recaptchaToken": "text",
"verificationId": "text",
"smsMarketingOptIn": true,
"_links": {
"self": {
"href": "text"
}
}
}{
"phoneNumber": "text",
"verificationCodeExpiration": "2026-01-01T00:00:00.000Z",
"status": "VERIFIED",
"smsMarketingOptIn": true,
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {
"self": {
"href": "text"
}
}
}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Body
phoneNumberstringRequired
verificationCodestringWrite-onlyOptional
recaptchaTokenstringWrite-onlyOptional
verificationIdstringWrite-onlyOptional
verificationCodeExpirationstring · date-timeRead-onlyOptional
statusstring · enumRead-onlyRequiredPossible values:
smsMarketingOptInbooleanOptional
Responses
200
Returns the deleted UserPhoneNumberDto
application/json
phoneNumberstringRequired
verificationCodestringWrite-onlyOptional
recaptchaTokenstringWrite-onlyOptional
verificationIdstringWrite-onlyOptional
verificationCodeExpirationstring · date-timeRead-onlyOptional
statusstring · enumRead-onlyRequiredPossible values:
smsMarketingOptInbooleanOptional
422
Returns an ErrorDto in case of failures.
delete/users/{userId}/phone-number
DELETE /apis/v2/users/{userId}/phone-number HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 155
{
"phoneNumber": "text",
"verificationCode": "text",
"recaptchaToken": "text",
"verificationId": "text",
"smsMarketingOptIn": true,
"_links": {
"self": {
"href": "text"
}
}
}{
"phoneNumber": "text",
"verificationCodeExpiration": "2026-01-01T00:00:00.000Z",
"status": "VERIFIED",
"smsMarketingOptIn": true,
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {
"self": {
"href": "text"
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Query parameters
isAdminAppliedChargebooleanOptionalExample:
trueResponses
200
Returns a PaymentMethod
application/json
idstringRequired
typestring · enumRequiredPossible values:
virtualCreditsnumberOptional
_linksobjectRequired
get/users/{userId}/payment-method
GET /apis/v2/users/{userId}/payment-method HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a PaymentMethod
{
"id": "text",
"type": "STRIPE",
"stripe": {
"paymentMethodId": "text",
"userId": "text"
},
"preferredCard": {
"id": "text",
"status": "text",
"stripe": {
"paymentMethodId": "text"
},
"brand": "text",
"numberPreview": "text",
"expirationMonth": 1,
"expirationYear": 1,
"funding": "text",
"_links": {
"self": {
"href": "text"
}
}
},
"preferredBankAccount": {
"id": "text",
"bankName": "text",
"accountHolderType": "text",
"last4": "text"
},
"virtualCredits": 1,
"paymentElement": {
"id": "text"
},
"_links": {}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200
Returns a PaymentMethodStripeEphemeralKeyDto
application/json
idstringRequired
objectstringRequired
associated_objectsstring[]Required
creatednumberRequired
expiresnumberRequired
livemodebooleanRequired
secretstringRequired
post/users/{userId}/payment-method/stripe/ephemeral-keys
POST /apis/v2/users/{userId}/payment-method/stripe/ephemeral-keys HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a PaymentMethodStripeEphemeralKeyDto
{
"id": "text",
"object": "text",
"associated_objects": [
"text"
],
"created": 1,
"expires": 1,
"livemode": true,
"secret": "text"
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Body
idstringRead-onlyRequired
terminalobjectOptional
tokenIdstringRequired
contextstring · enum · nullableOptionalPossible values:
ipAddressstringRead-onlyRequired
userAgentstringRead-onlyRequired
objectstringRead-onlyRequired
creatednumberRead-onlyRequired
clientSecretstringRead-onlyRequired
Responses
200
Returns a PaymentMethodStripeSetupIntentDto
application/json
idstringRead-onlyRequired
terminalobjectOptional
tokenIdstringRequired
contextstring · enum · nullableOptionalPossible values:
ipAddressstringRead-onlyRequired
userAgentstringRead-onlyRequired
objectstringRead-onlyRequired
creatednumberRead-onlyRequired
clientSecretstringRead-onlyRequired
post/users/{userId}/payment-method/stripe/setup-intents
POST /apis/v2/users/{userId}/payment-method/stripe/setup-intents HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52
{
"terminal": {},
"tokenId": "text",
"context": "booking"
}200
Returns a PaymentMethodStripeSetupIntentDto
{
"id": "text",
"terminal": {},
"tokenId": "text",
"context": "booking",
"ipAddress": "text",
"userAgent": "text",
"object": "text",
"created": 1,
"clientSecret": "text"
}delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Query parameters
typestring · enumOptionalExample:
PREVIEWPossible values: Responses
200
Returns a PaymentMethod
application/json
idstringRequired
typestring · enumRequiredPossible values:
virtualCreditsnumberOptional
_linksobjectRequired
delete/users/{userId}/payment-method/default
DELETE /apis/v2/users/{userId}/payment-method/default HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a PaymentMethod
{
"id": "text",
"type": "STRIPE",
"stripe": {
"paymentMethodId": "text",
"userId": "text"
},
"preferredCard": {
"id": "text",
"status": "text",
"stripe": {
"paymentMethodId": "text"
},
"brand": "text",
"numberPreview": "text",
"expirationMonth": 1,
"expirationYear": 1,
"funding": "text",
"_links": {
"self": {
"href": "text"
}
}
},
"preferredBankAccount": {
"id": "text",
"bankName": "text",
"accountHolderType": "text",
"last4": "text"
},
"virtualCredits": 1,
"paymentElement": {
"id": "text"
},
"_links": {},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Query parameters
expandstring[]Optional
Responses
200
Returns a UserProfile
application/json
idstringRequired
typestring · enumRead-onlyRequiredPossible values:
firstNamestringRead-onlyOptional
lastNamestringRead-onlyOptional
genderstringRead-onlyOptional
birthdaystring · date-timeRead-onlyOptional
initialsstringRead-onlyOptional
descriptionstringRequired
pictureobject · nullableRead-onlyOptional
usattRatingnumber · nullableRead-onlyOptional
duprProfileUrlstring · nullableRead-onlyOptional
memberSincestring · date-timeRead-onlyRequired
membershipSubscriptionobject · nullableRead-onlyOptionalDeprecated
membershipEnrollmentobject · nullableRead-onlyOptional
kidsobject · nullableRead-onlyRequired
_linksobjectRequired
get/users/{userId}/profile
GET /apis/v2/users/{userId}/profile HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a UserProfile
{
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200
Returns an Image
application/json
idstringRequired
get/users/{userId}/profile/picture
GET /apis/v2/users/{userId}/profile/picture HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns an Image
{
"id": "text",
"small": {
"href": "text"
},
"medium": {
"href": "text"
},
"large": {
"href": "text"
},
"_links": {
"self": {
"href": "text"
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200
Returns an Image
application/json
idstringRequired
get/users/{userId}/security-picture
GET /apis/v2/users/{userId}/security-picture HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns an Image
{
"id": "text",
"small": {
"href": "text"
},
"medium": {
"href": "text"
},
"large": {
"href": "text"
},
"_links": {
"self": {
"href": "text"
}
}
}delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
deviceIdstringRequiredExample:
aced9ca9-fcc5-409a-b3d4-990301b53ae8userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
201
Returns the deleted device as DeviceDto
application/json
idstringRead-onlyRequired
tokenstringRequired
namestringOptional
userobjectRequired
bundlestringWrite-onlyOptional
platformstringWrite-onlyOptional
_linksobjectRequired
delete/users/{userId}/devices/{deviceId}
DELETE /apis/v2/users/{userId}/devices/{deviceId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
201
Returns the deleted device as DeviceDto
{
"id": "text",
"token": "text",
"name": "text",
"user": {},
"_links": {}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Body
idstringRead-onlyRequired
tokenstringRequired
namestringOptional
userobjectRequired
bundlestringWrite-onlyOptional
platformstringWrite-onlyOptional
_linksobjectRequired
Responses
201
Returns a DeviceDto
application/json
idstringRead-onlyRequired
tokenstringRequired
namestringOptional
userobjectRequired
bundlestringWrite-onlyOptional
platformstringWrite-onlyOptional
_linksobjectRequired
post/users/{userId}/devices
POST /apis/v2/users/{userId}/devices HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 86
{
"token": "text",
"name": "text",
"user": {},
"bundle": "text",
"platform": "text",
"_links": {}
}201
Returns a DeviceDto
{
"id": "text",
"token": "text",
"name": "text",
"user": {},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200
Returns a UserRatingsCollection
application/json
_totalnumberRequired
get/users/{userId}/ratings
GET /apis/v2/users/{userId}/ratings HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a UserRatingsCollection
{
"items": [
{
"id": "text",
"type": "DUPR",
"singles": 1,
"doubles": 1,
"lastUpdated": "2026-01-01T00:00:00.000Z",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200
Returns a UserRating
application/json
idstringRead-onlyRequired
typestring · enumRead-onlyRequiredPossible values:
singlesnumberRead-onlyRequired
doublesnumberRead-onlyRequired
lastUpdatedstring · date-timeRead-onlyRequired
422
Returns an ErrorDto in case of validation errors or failures.
Possible error codes are:UR000: User ratings not connectedUR001: (rating, minRating, maxRating) => ${rating} rating must be between ${minRating} and ${maxRating}.UR002: Your DUPR account is already associated with another user.
patch/users/{userId}/ratings
PATCH /apis/v2/users/{userId}/ratings HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "text",
"type": "DUPR",
"singles": 1,
"doubles": 1,
"lastUpdated": "2026-01-01T00:00:00.000Z",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200
Returns the url to the user`s DUPR profile
application/json
stringOptional
get/users/{userId}/profile/dupr
GET /apis/v2/users/{userId}/profile/dupr HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns the url to the user`s DUPR profile
textget
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200
Returns a UserNotes
application/json
notesstringRequired
get/users/{userId}/notes
GET /apis/v2/users/{userId}/notes HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a UserNotes
{
"notes": "text"
}put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Body
notesstringRequired
Responses
200
Returns a UserNotes
application/json
notesstringRequired
422
Returns an ErrorDto in case of validation errors or failures.
put/users/{userId}/notes
PUT /apis/v2/users/{userId}/notes HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"notes": "text"
}{
"notes": "text"
}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Body
notesstringRequired
Responses
200
Returns the deleted UserNotes
application/json
notesstringRequired
422
Returns an ErrorDto in case of failures.
delete/users/{userId}/notes
DELETE /apis/v2/users/{userId}/notes HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"notes": "text"
}{
"notes": "text"
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Query parameters
paymentContextstring · enumOptionalExample:
bookingPossible values: isAdminAppliedChargebooleanOptionalExample:
trueexpandstring[]OptionalExample:
["items._links.contextAvailability"]Responses
200
Returns a UserPaymentElementCollectionDto
application/json
itemsstring[]Required
_totalnumberRequired
get/users/{userId}/payment-elements
GET /apis/v2/users/{userId}/payment-elements HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a UserPaymentElementCollectionDto
{
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
paymentElementIdstringRequiredExample:
pm_1RAGN7JZDKZ6l3VXCeCXFna9userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Query parameters
expandstring[]OptionalExample:
["items._links.contextAvailability"]Responses
200
Returns a UserPaymentElementCollectionDto
application/json
itemsstring[]Required
_totalnumberRequired
get/users/{userId}/payment-elements/{paymentElementId}
GET /apis/v2/users/{userId}/payment-elements/{paymentElementId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a UserPaymentElementCollectionDto
{
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
paymentElementIdstringRequiredExample:
pm_1RAGN7JZDKZ6l3VXCeCXFna9userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Query parameters
typestring · enumOptionalExample:
PREVIEWPossible values: Responses
200
Deletes a payment element, and returns the deleted UserPaymentElementDto as part of the response.
application/json
idstringRead-onlyRequired
typestring · enumRead-onlyRequiredPossible values:
displayNamestringRead-onlyRequired
descriptionstringRead-onlyRequired
createdAtstring · date-timeRead-onlyRequired
statusstring · enumRead-onlyRequiredPossible values:
_linksobjectRead-onlyRequired
delete/users/{userId}/payment-elements/{paymentElementId}
DELETE /apis/v2/users/{userId}/payment-elements/{paymentElementId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Deletes a payment element, and returns the deleted UserPaymentElementDto as part of the response.
{
"id": "text",
"user": {
"id": "text"
},
"type": "klarna",
"displayName": "text",
"description": "text",
"contextAvailability": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"createdAt": "2026-01-01T00:00:00.000Z",
"status": "ACTIVE",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
paymentElementIdstringRequiredExample:
pm_1RAGN7JZDKZ6l3VXCeCXFna9userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Responses
200
Returns a UserPaymentElementContextAvailabilityCollectionDto
application/json
itemsstring[]Required
_totalnumberRequired
get/users/{userId}/payment-elements/{paymentElementId}/context-availability
GET /apis/v2/users/{userId}/payment-elements/{paymentElementId}/context-availability HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a UserPaymentElementContextAvailabilityCollectionDto
{
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
paymentElementIdstringRequiredExample:
pm_1RAGN7JZDKZ6l3VXCeCXFna9contextstring · enumRequiredExample:
bookingPossible values: userIdstringRequiredExample:
o0drORnu2aUjJEvceKPa4QUyJgC2Body
isDefaultbooleanOptional
Responses
200
Return the updated payment method context availability UserPaymentElementContextAvailabilityDto
application/json
idstring · enumRead-onlyRequiredPossible values:
isDefaultbooleanRequired
_linksobjectRead-onlyRequired
patch/users/{userId}/payment-elements/{paymentElementId}/context-availability/{context}
PATCH /apis/v2/users/{userId}/payment-elements/{paymentElementId}/context-availability/{context} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"isDefault": true
}200
Return the updated payment method context availability UserPaymentElementContextAvailabilityDto
{
"id": "booking",
"user": {
"id": "text"
},
"paymentElement": {
"id": "text"
},
"isDefault": true,
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
currentQuery parameters
sourcestringOptionalExample:
BOOKINGeventIdstringOptionalExample:
event-uuidcreatedStartDatestring · date-timeOptionalExample:
2024-01-01T00:00:00.000ZcreatedEndDatestring · date-timeOptionalExample:
2024-01-31T23:59:59.999ZpagenumberOptionalExample:
1ippnumberOptionalExample:
30sortstringOptionalExample:
Sort format: -fieldName (DESC) or +fieldName (ASC). Allowed fields: createdAt, createdDate, gross, id
-createdDateResponses
200
Returns a CustomerSettlementCollectionDto
application/json
get/users/{userId}/settlements
GET /apis/v2/users/{userId}/settlements HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a CustomerSettlementCollectionDto
{
"items": [
{
"id": "text",
"code": "text",
"createdDate": "2026-01-01T00:00:00.000Z",
"title": "text",
"source": "text",
"description": "text",
"summary": {
"paymentMethod": "text",
"paymentMethodBrand": "text",
"paymentMethodLast4": "text",
"currency": "text",
"subtotal": 1,
"discounts": 1,
"taxableAmount": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"taxAmount": 1,
"gross": 1,
"virtualCredits": 1
},
"payment": {
"id": "text"
},
"lineItems": {
"items": [
{
"id": "text",
"description": "text",
"quantity": 1,
"unitPrice": 1,
"subtotal": 1,
"totalDiscount": 1,
"taxableAmount": 1,
"taxAmount": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"grossAmount": 1
}
],
"total": 1
},
"event": {
"id": "text"
},
"orders": {
"_total": 1
},
"_links": {}
}
],
"_pagination": {
"page": 1,
"ipp": 1,
"count": 1,
"total": 1
},
"_links": {
"self": {
"href": "text"
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequiredExample:
currentsettlementIdstringRequiredExample:
settlement-uuidResponses
200
Returns a CustomerSettlementDto
application/json
idstringRequired
Unique identifier for the settlement
codestringRequired
Short code derived from the first 8 characters of the settlement id
createdDatestring · date-timeRequired
Date the settlement was created
titlestringRequired
Human-friendly title for the settlement
sourcestring · nullableRequired
Source type of the settlement (e.g., BOOKING, MEMBERSHIP, EVENT_SIGNUP)
descriptionstring · nullableRequired
Description of the settlement
_linksobjectRequired
get/users/{userId}/settlements/{settlementId}
GET /apis/v2/users/{userId}/settlements/{settlementId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a CustomerSettlementDto
{
"id": "text",
"code": "text",
"createdDate": "2026-01-01T00:00:00.000Z",
"title": "text",
"source": "text",
"description": "text",
"summary": {
"paymentMethod": "text",
"paymentMethodBrand": "text",
"paymentMethodLast4": "text",
"currency": "text",
"subtotal": 1,
"discounts": 1,
"taxableAmount": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"taxAmount": 1,
"gross": 1,
"virtualCredits": 1
},
"payment": {
"id": "text"
},
"lineItems": {
"items": [
{
"id": "text",
"description": "text",
"quantity": 1,
"unitPrice": 1,
"subtotal": 1,
"totalDiscount": 1,
"taxableAmount": 1,
"taxAmount": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"grossAmount": 1
}
],
"total": 1
},
"event": {
"id": "text"
},
"orders": {
"_total": 1
},
"_links": {}
}Last updated
Was this helpful?