Skip to main content
GET
cURL

Response Examples

Success Response (200 OK)

No Custom Drugs (200 OK)

Invalid Parameters (400 Bad Request)

Unauthorized (401)

Response Fields

Success Response Data

The response returns an array of custom drug objects. Optional fields are omitted when not set on the drug.

Common Response Fields

All responses include these standard fields:

Path Parameters

Status Codes

Integration Notes

  1. Scope Requirement: Your API token must include the read:custom_drug scope.
  2. Combined List: Returns both organization-level and user-level custom drugs for the user.
  3. Prefill: Use custom_drug_id to prefill the prescription form via query parameters.
  4. Optional Fields: Fields that are not set on a drug are omitted from the response.
  5. Store Request ID: Always log the requestId for debugging 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
required

User ID

Response

Custom drugs retrieved successfully

success
boolean
statusCode
integer
message
string
code
string
Example:

"SUCCESS"

data
object[]
timestamp
string
requestId
string