API ReferenceContactsProviders

Get provider 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

provider_idstringRequiredformat: "uuid"

Response

Single provider
idstringOptionalformat: "uuid"
entity_namestringOptional
abnstringOptional
Australian Business Number
emailstringOptionalformat: "email"
activebooleanOptional
Active status
primary_phone_numberstringOptional
Primary phone number
addressstringOptional
Street address
statestringOptional

State (uppercase): NSW, QLD, VIC, SA, WA, TAS, ACT, NT

postcodestringOptional

4-digit postcode

citystringOptional
City
ndis_provider_numberstringOptional
NDIS provider number
bsbstringOptional

BSB (read-only)

bank_account_numberstringOptional

Bank account number (read-only)

bank_account_namestringOptional

Bank account name (read-only)

Errors

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