โ๏ธ Get Prescribers by Clinic โ Field Reference
This endpoint fetches the list of prescribers associated with a specific clinic. The returned structure follows PrescriberDetailsDto and related internal models.
| Field | Description |
|---|---|
| x-api-key | API Key required for authentication. |
| clinicId | Clinic ID in header overrides route parameter (optional). |
| Param | Description |
|---|---|
| clinicId | Unique clinic identifier to fetch prescribers for โ mandatory. |
This API returns all prescribers assigned to the given clinic, including:
Prescriber Identity
| Field | Description |
|---|---|
| fName | First name of prescriber. |
| lName | Last name of prescriber. |
| username | Unique username. |
| gender | โMโ, โFโ, โOโ. |
| dateOfBirth | Format: โYYYY-MM-DDโ. |
| Field | Description |
|---|---|
| npi | National Provider Identifier. |
| dea | DEA number. |
| speciality | Medical specialty (optional). |
| providerType | Optional provider classification. |
| Field | Description |
|---|---|
| address1 | Primary address line. |
| address2 | Optional second line. |
| city | Valid US city. |
| state | Two-letter US state code. |
| zipCode | 5-digit numeric zip. |
| country | Defaults to โUSโ. |
| Field | Description |
|---|---|
| Optional; required if SMS consent true. | |
| phone | Mandatory; validated phone number. |
| authSmsConsent | Mandatory boolean. |
| smsConsent | Optional boolean. |
| dataRatesSmsConsent | Optional boolean (default โtrueโ). |
| Notice | Details |
|---|---|
| Validation | All fields returned were previously validated during creation. |
| Permissions | API key must be authorized for the requested clinic. |
| Errors | 404 returned if clinic has no prescribers or does not exist. |
Clinic ID to fetch prescribers for
Get Prescribers by Clinic