Skip to main content
GET
cURL

Response Examples

Success Response - Provider User (200 OK)

Success Response - Non-Provider User (200 OK)

User Not Found (404 Not Found)

Invalid Parameters (400 Bad Request)

Unauthorized (401)

Insufficient Permissions (403 Forbidden)

Response Fields

Success Response Data

Details Object

Provider Details Object (when access_roles includes “provider”)

Australian Address Object

Common Response Fields

All responses include these standard fields:

Path Parameters

Status Codes

Integration Notes

  1. Store Request ID: Always log the requestId for debugging support requests
  2. Handle 404 Status: Check if the user exists before attempting to read
  3. Permission Requirements: Ensure your API token has the READ_USER scope
  4. Organization Access: You can only read users from organizations you have access to
  5. Provider Data Availability: If provider details cannot be retrieved, provider_details will be null
  6. Caching: Consider caching user data with appropriate TTL to reduce API calls
  7. Role-Based Fields: Non-provider users will not have the provider_details field in the response

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