API ReferenceContactsParticipants

Get participant by ID

Authentication

AuthorizationBearer
API key issued for your account. Send as Bearer token in the Authorization header.
X-Plan-Manager-Idstring
Plan manager UUID. Required on all public API requests to scope data access.

Path parameters

participant_idstringRequiredformat: "uuid"
Participant UUID

Response

Single participant
idstringformat: "uuid"
Unique identifier for the participant
first_namestring
middle_namestring
last_namestring
participant_numberstring
NDIS participant number
emailstringformat: "email"
Contact email
statestring
statusstring
service_region_idstring
postcodestring
approval_requiredboolean
date_of_birthdate
phone_numberstring
genderstring
titlestring
preferred_namestring
approval_timeoutinteger
address_line_1string
address_line_2string
citystring
bsbstring
bank_account_numberstring
bank_account_namestring
date_ceaseddate
reason_for_leavingstring
aboriginal_torres_straitboolean
pronounsstring
participant_approvedboolean
caldboolean
interpreter_requiredboolean
onboard_datedate
postal_statementboolean
exit_reason_categoryobject

Reference to an exit reason category/subcategory (present only when set).

exit_reason_subcategoryobject

Reference to an exit reason category/subcategory (present only when set).

status_changesmap from strings to any

History of status changes (read-only)

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error