ASDinCloudDocs

The parent object

View as Markdown

Parent records hold the contact details and preferences of a parent or guardian linked to an athlete.

Attributes

idinteger
Identifier assigned by the API.
sport_idinteger
ID of the sport.
athlete_idinteger
ID of the athlete in the selected sport.
firstnamestring
Given name, up to 60 characters.
surnamestring
Family name, up to 60 characters.
taxcodestring
Tax identification code, up to 16 characters.
relationshipstring or null
Relationship to the athlete.
emailstring or null
Contact email.
phonestring or null
Contact phone, up to 15 characters.
birthdayinteger or null
Date of birth as Unix seconds.
birth_citystring or null
Place of birth.
birth_provincestring or null
Province or region of birth.
is_primaryinteger
1 for a primary parent, otherwise 0.
to_notifyboolean or null
Whether this contact receives notifications.
metadatamap or null
Additional fields, including residence details.
athlete_fullnamestring
Name of the related athlete when available.
privacy_consentboolean or null
Recorded privacy consent.
privacy_accepted_atinteger or null
Consent timestamp as Unix seconds.

List parents

View as Markdown
GET/api/v1/parents

Lists parent records in the workspace.

Permissions

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

Headers

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

Query parameters

athlete_idinteger
Limit the results to this athlete.
expand_athleteinteger
Use 1 to include the related athlete.
qstring
Search given name or surname.
lengthinteger
Number of records to return.
startinteger
Zero-based offset.
drawstring
Optional request marker echoed in the response.
sortstring
Sort by id, firstname, surname, email, taxcode, athlete_fullname, 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 matching parents 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 parent

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

Returns one parent by ID.

Permissions

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

Headers

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

Path parameters

idintegerRequired
ID of the parent.

Query parameters

expand_athleteinteger
Use 1 to include the related athlete.

Returns

The parent 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 parent

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

Updates a parent by ID.

Permissions

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

Headers

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

Path parameters

idintegerRequired
ID of the parent.

Body parameters

athlete_idinteger
ID of the athlete in the selected sport.
firstnamestringRequired
Given name, up to 60 characters.
surnamestringRequired
Family name, up to 60 characters.
taxcodestringRequired
Tax identification code, up to 16 characters.
relationshipstring or null
Relationship to the athlete.
emailstring or null
Contact email.
phonestring or null
Contact phone, up to 15 characters.
birthdayinteger or date string or null
Date of birth as Unix seconds or an ISO date.
birth_citystring or null
Place of birth.
birth_provincestring or null
Province or region of birth.
birth_countrystring or null
Country of birth. Stored in metadata.
addressstring or null
Street address. Stored in metadata.
citystring or null
City of residence. Stored in metadata.
zipstring or null
Postal code. Stored in metadata.
provincestring or null
Province or region of residence. Stored in metadata.
countrystring or null
Country of residence. Stored in metadata.
nationalitystring or null
Nationality. Stored in metadata.
is_primaryboolean
Set true to mark the parent as primary. Omission on update defaults to false.
to_notifyboolean or null
Whether this contact receives notifications.
metadatamap or null
Additional fields, including residence details.

Include the contact and profile values you want to keep. Omitted editable details can be cleared. A minor athlete must retain a primary parent.

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.
422
The record failed validation or the change would leave a minor athlete without a primary parent.

Delete a parent

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

Removes a parent record when its linked payments and primary-parent status allow it.

Permissions

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

Headers

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

Path parameters

idintegerRequired
ID of the parent.

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.
400
The parent has payments or could not be removed.
422
The record failed validation or the change would leave a minor athlete without a primary parent.

Export parents

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

Downloads the matching parent records as CSV.

Permissions

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

Headers

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

Query parameters

athlete_idinteger
Limit the results to this athlete.
include_birthinteger
Use 1 to include birth details.
include_contactsinteger
Use 1 to include contact details.
include_residenceinteger
Use 1 to include residence and contact details.
include_consentsinteger
Use 1 to include consent and notification information.
include_athleteinteger
Use 1 to include the related athlete.
include_identity_docinteger
Use 1 to include identification document details.
include_metadatainteger
Use 1 to include custom fields.

Returns

Returns a CSV attachment with all matching records.

Errors

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

Send a parent portal invitation

View as Markdown
POST/api/v1/parents/{id}/portal-invite

Sends or resends a parent portal invitation to the contact email.

Permissions

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

Headers

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

Path parameters

idintegerRequired
ID of the parent.

Returns

Returns invited: true when the invitation is sent.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.
400
The invitation could not be sent.
404
The requested record was not found.
422
The parent needs an email address.