ASDinCloudDocs
API ReferenceMemberships

Memberships

View as Markdown

The membership object

View as Markdown

Memberships track a person's registration with a governing organization for a period.

Attributes

idinteger
Identifier assigned by the API.
sport_idinteger
ID of the sport.
subject_typestring
Use athlete, coach, or staff.
subject_idinteger
ID of the person holding the membership.
organizationstring
Governing organization, up to 100 characters.
card_typestring or null
Membership card category, up to 100 characters.
membership_plan_idinteger or null
ID of the associated membership plan.
card_numberstring or null
Membership card number, up to 100 characters.
issued_atinteger or null
Issue date, as Unix seconds or an ISO date.
valid_frominteger
Start date, as Unix seconds or an ISO date.
valid_tointeger
End date, at or after the start date. The validity period can span up to 366 days.
season_labelstring or null
Season label, for example 2026/2027.
subscription_idinteger or null
ID of an associated subscription.
payment_idinteger or null
ID of an associated payment.
canceled_atinteger or null
Cancellation date. Use null to clear it.
notesstring or null
Notes about the membership.
metadatamap or null
Additional membership information.
statusstring
Current status: active, pending, expired, or canceled.
subject_namestring or null
Name of the member when available.
membership_plan_namestring or null
Display name of the associated plan when available.

List memberships

View as Markdown
GET/api/v1/memberships

Lists membership records in the workspace.

Permissions

Send your API key in X-API-Key. Required permissions are Memberships → Read.

Headers

X-Sport-Idinteger
Use the sport ID to limit the response to one sport.

Query parameters

subject_typestring
Use athlete, coach, or staff.
subject_idinteger
ID of the person holding the membership.
organizationstring
Governing organization, up to 100 characters.
seasonstring
Season label, for example 2026/2027.
card_typestring or null
Membership card category, up to 100 characters.
statusstring
Use active, pending, expired, canceled, or all.
team_idinteger
Filter by team assignment.
qstring
Search names, organization, card number, card category, or season.
lengthinteger
Number of records to return.
startinteger
Zero-based offset.
drawstring
Optional request marker echoed in the response.
sortstring
Sort by id, subject_name, organization, card_number, card_type, season_label, issued_at, valid_from, valid_to, status, tsc, or tsu. Prefix the field name with a minus sign for descending order.
orderstring
Direction for unprefixed sort fields. Use asc or desc.

Returns

Returns memberships in data with counts before and after text search.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.

Retrieve a membership

View as Markdown
GET/api/v1/memberships/{id}

Returns one membership by ID.

Permissions

Send your API key in X-API-Key. Required permissions are Memberships → Read.

Headers

X-Sport-IdintegerRequired
The sport ID from List sports. Use the sport the record belongs to.

Path parameters

idintegerRequired
ID of the membership.

Returns

The membership is returned in data.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.
404
The requested record was not found.

Update a membership

View as Markdown
PATCH / PUT / POST/api/v1/memberships/{id}

Updates a membership by ID.

Permissions

Send your API key in X-API-Key. Required permissions are Memberships → Write.

Headers

X-Sport-IdintegerRequired
The sport ID from List sports. Use the sport the record belongs to.

Path parameters

idintegerRequired
ID of the membership.

Body parameters

subject_typestring
Use athlete, coach, or staff.
subject_idinteger
ID of the person holding the membership.
organizationstring
Governing organization, up to 100 characters.
card_typestring or null
Membership card category, up to 100 characters.
membership_plan_idinteger or null
ID of the associated membership plan.
card_numberstring or null
Membership card number, up to 100 characters.
issued_atinteger or date string or null
Issue date, as Unix seconds or an ISO date.
valid_frominteger or date string
Start date, as Unix seconds or an ISO date.
valid_tointeger or date string
End date, at or after the start date. The validity period can span up to 366 days.
season_labelstring or null
Season label, for example 2026/2027.
subscription_idinteger or null
ID of an associated subscription.
payment_idinteger or null
ID of an associated payment.
canceled_atinteger or date string or null
Cancellation date. Use null to clear it.
notesstring or null
Notes about the membership.
metadatamap or null
Additional membership information.

Returns

Returns a successful update response.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.
404
The requested record was not found.
400
The update failed validation, including a possible overlap with another membership.

Delete a membership

View as Markdown
DELETE/api/v1/memberships/{id}
POST/api/v1/memberships/{id}/delete

Removes a membership record.

Permissions

Send your API key in X-API-Key. Required permissions are Memberships → Write.

Headers

X-Sport-IdintegerRequired
The sport ID from List sports. Use the sport the record belongs to.

Path parameters

idintegerRequired
ID of the membership.

Returns

Returns a successful removal response.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.
404
The requested record was not found.

Export memberships

View as Markdown
GET/api/v1/memberships/export

Downloads membership history or a directory with current membership status.

Permissions

Send your API key in X-API-Key. Required permissions are Memberships → Read.

Headers

X-Sport-IdintegerRequired
The sport ID from List sports. Use the sport the record belongs to.

Query parameters

modestring
Use history for membership records or current for a directory of people with current membership details. Defaults to history.
subject_typestring
Use athlete, coach, or staff.
subject_idinteger
ID of the person holding the membership.
organizationstring
Governing organization, up to 100 characters.
seasonstring
Season label, for example 2026/2027.
card_typestring or null
Membership card category, up to 100 characters.
statusstring
Use active, pending, expired, canceled, or all.
team_idinteger
Filter by team assignment.

Returns

Returns a semicolon-delimited CSV attachment. Current mode uses subject type, organization, and season filters.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.