ASDinCloudDocs
API ReferenceDirectors

The director object

View as Markdown

Directors are workspace staff records. You can list directors, manage their details, and export a directory.

Attributes

idinteger
Identifier assigned by the API.
firstnamestring
Given name, up to 60 characters.
surnamestring
Family name, up to 60 characters.
emailstring or null
Contact email.
phonestring or null
Contact phone.
birthdayinteger or null
Date of birth as Unix seconds.
taxcodestring or null
Tax identification code.
birth_citystring or null
Place of birth.
birth_provincestring or null
Province or region of birth.
birth_countrystring or null
Country of birth.
nationalitystring or null
Nationality.
addressstring or null
Street address.
citystring or null
City of residence.
provincestring or null
Province or region of residence.
zipstring or null
Postal code.
countrystring or null
Country of residence.
notesstring or null
Notes about the director.
id_numberstring or null
Identification document number.
car_makestring or null
Vehicle make.
car_modelstring or null
Vehicle model.
car_platestring or null
Vehicle registration number.
bank_namestring or null
Bank name.
ibanstring or null
Bank account IBAN.
to_notifyboolean
Whether to send notifications to this director.
privacy_consentboolean or null
Recorded privacy consent.
privacy_accepted_atinteger or null
Consent timestamp in Unix seconds.
metadatamap or null
Additional fields. Sending metadata replaces the existing map.
typestring
Director records have type staff.
sport_idnull
Directors are workspace-wide.
archived_atinteger or null
Archive timestamp in Unix seconds, or null for an active director.
to_notify_updated_atinteger or null
Unix timestamp of the most recent change to the notification preference.
tscinteger
Creation time as a Unix timestamp in seconds.
tsuinteger
Last update time as a Unix timestamp in seconds.

List directors

View as Markdown
GET/api/v1/directors

Lists director records in the workspace.

Permissions

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

Query parameters

archivedboolean
Use true for archived directors. Defaults to false.
team_idinteger
Include directors assigned to this team.
exclude_team_idinteger
Exclude directors assigned to this team.
qstring
Search by name, email, or tax code.
lengthinteger
Number of records to return.
startinteger
Zero-based offset.
drawstring
Optional request marker echoed in the response.
sortstring
Sort by id, 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 records in data, the counts before and after text search, and the echoed draw marker.

Errors

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

Retrieve a director

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

Returns one director by ID.

Permissions

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

Headers

X-Sport-IdintegerRequired
Supply a valid sport ID from List sports as the request context.

Path parameters

idintegerRequired
ID of the director.

Returns

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

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

Updates a director by ID.

Permissions

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

Headers

X-Sport-IdintegerRequired
Supply a valid sport ID from List sports as the request context.

Path parameters

idintegerRequired
ID of the director.

Body parameters

firstnamestring
Given name, up to 60 characters.
surnamestring
Family name, up to 60 characters.
emailstring or null
Contact email.
phonestring or null
Contact phone.
birthdayinteger or null
Date of birth as Unix seconds.
taxcodestring or null
Tax identification code.
birth_citystring or null
Place of birth.
birth_provincestring or null
Province or region of birth.
birth_countrystring or null
Country of birth.
nationalitystring or null
Nationality.
addressstring or null
Street address.
citystring or null
City of residence.
provincestring or null
Province or region of residence.
zipstring or null
Postal code.
countrystring or null
Country of residence.
notesstring or null
Notes about the director.
id_numberstring or null
Identification document number.
car_makestring or null
Vehicle make.
car_modelstring or null
Vehicle model.
car_platestring or null
Vehicle registration number.
bank_namestring or null
Bank name.
ibanstring or null
Bank account IBAN.
to_notifyboolean
Whether to send notifications to this director.
privacy_consentboolean or null
Recorded privacy consent.
privacy_accepted_atinteger or null
Consent timestamp in Unix seconds.
metadatamap or null
Additional fields. Sending metadata replaces the existing map.
archivedboolean
Use true to archive the director or false to restore the record.

When supplying a name field, use a non-empty value.

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
One or more fields failed validation.

Delete a director

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

Removes a director from the workspace.

Permissions

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

Headers

X-Sport-IdintegerRequired
Supply a valid sport ID from List sports as the request context.

Path parameters

idintegerRequired
ID of the director.

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 director could not be removed.

Export directors

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

Downloads matching directors as a CSV file.

Permissions

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

Query parameters

statusstring
Use archived to export archived directors. The default is to export active directors.
archived_atinteger
Legacy filter. Use 1 to export archived directors.
team_idinteger
Include directors assigned to this team.
exclude_team_idinteger
Exclude directors assigned to this team.
include_birthinteger
Use 1 to include birth and nationality columns.
include_residenceinteger
Use 1 to include residence and contact columns.
include_contactsinteger
Use 1 to include email and phone.
include_qualificationinteger
Use 1 to include qualification columns.
include_metadatainteger
Use 1 to include custom metadata columns.

Returns

Returns a CSV attachment with all matching rows.

Errors

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