Get participant by ID

{
  "id": "string",
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "participant_number": "string",
  "email": "string",
  "state": "string",
  "status": "string",
  "service_region_id": "string",
  "postcode": "string",
  "approval_required": true,
  "date_of_birth": "2023-01-15",
  "phone_number": "string",
  "gender": "string",
  "title": "string",
  "preferred_name": "string",
  "approval_timeout": 1,
  "address_line_1": "string",
  "address_line_2": "string",
  "city": "string",
  "bsb": "string",
  "bank_account_number": "string",
  "bank_account_name": "string",
  "date_ceased": "2023-01-15",
  "reason_for_leaving": "string",
  "aboriginal_torres_strait": true,
  "pronouns": "string",
  "participant_approved": true,
  "cald": true,
  "interpreter_required": true,
  "onboard_date": "2023-01-15",
  "postal_statement": true,
  "exit_reason_category": {
    "id": "string",
    "name": "string"
  },
  "exit_reason_subcategory": {
    "id": "string",
    "name": "string"
  },
  "status_changes": {}
}

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

idstringOptionalformat: "uuid"

Unique identifier for the participant

first_namestringOptional

middle_namestringOptional

last_namestringOptional

participant_numberstringOptional

NDIS participant number

emailstringOptionalformat: "email"

Contact email

statestringOptional

statusstringOptional

service_region_idstringOptional

postcodestringOptional

approval_requiredbooleanOptional

date_of_birthdateOptional

phone_numberstringOptional

genderstringOptional

titlestringOptional

preferred_namestringOptional

approval_timeoutintegerOptional

address_line_1stringOptional

address_line_2stringOptional

citystringOptional

bsbstringOptional

bank_account_numberstringOptional

bank_account_namestringOptional

date_ceaseddateOptional

reason_for_leavingstringOptional

aboriginal_torres_straitbooleanOptional

pronounsstringOptional

participant_approvedbooleanOptional

caldbooleanOptional

interpreter_requiredbooleanOptional

onboard_datedateOptional

postal_statementbooleanOptional

exit_reason_categoryobjectOptional

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

exit_reason_subcategoryobjectOptional

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

status_changesmap from strings to anyOptional

History of status changes (read-only)

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error