Skip to main content
GET
cURL

Response Examples

Success Response - Provider User (200 OK)

Success Response - Non-Provider User (200 OK)

Provider Role, No Provider Record (200 OK)

The user holds the provider role but has no provider record, so provider_details is null and can_prescribe is false.

User Not Found (404 Not Found)

Invalid Parameters (400 Bad Request)

Unauthorized (401)

Insufficient Scope (401 Unauthorized)

Checking a prescriber can prescribe

Read is_escript_ready.can_prescribe. It is true only when the user can create an electronic prescription now. When it is false, the other flags say why: is_escript_ready is absent for users without the provider or rx_queue_manager role.
There is no external_user_id or partner_user_id. Map user_id to your own record.

Response Fields

Success Response Data

Details Object

Every key is always present. An unknown value is null, never omitted.

Provider Details Object

Every key is always present; an unset value is null.

Australian Address Object

is_escript_ready Object

Path Parameters

Status Codes

Integration Notes

  1. provider_details reflects the user’s role, not their capability. Use is_escript_ready.can_prescribe for that.
  2. Requires the READ_USER scope.
  3. Log requestId for support requests.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-organization-secret
string
required

Organization secret for authentication - provided by Parchment

Path Parameters

organization_id
string<uuid>
required

Organization ID

user_id
string<uuid>
required

User ID

Response

User retrieved successfully

success
boolean
required

Indicates if the request was successful

Example:

true

statusCode
integer
required
Example:

200

message
string
required
Example:

"User details retrieved successfully"

code
string
required

Always SUCCESS.

Example:

"SUCCESS"

data
object
required

Full detail for a single user.

timestamp
string<date-time>
required

ISO 8601 timestamp of the response

Example:

"2024-01-15T10:30:00.000Z"

requestId
string
required

Unique identifier for request tracing

Example:

"req_1705312200000_abc123"