×
Clinic Object - JSON Structure
Response structure from OpenDental API when fetching clinics (locations).
Example Response (GET /api/clinics):
[
{
"ClinicNum": 0,
"Description": "Headquarters",
"Abbr": "HQ",
"Address": "123 Main St",
"Address2": "",
"City": "Salem",
"State": "Oregon",
"Zip": "97301",
"BillingAddress": "123 Main St",
"BillingAddress2": "",
"BillingCity": "Salem",
"BillingState": "Oregon",
"BillingZip": "97301",
"PayToAddress": "",
"PayToAddress2": "",
"PayToCity": "",
"PayToState": "",
"PayToZip": "",
"Phone": "5035551234",
"IsHidden": "false"
},
{
"ClinicNum": 1,
"Description": "Clinic 1",
"Abbr": "Clinic1",
"Address": "333 Blackwood St",
"City": "Salem",
"State": "Oregon",
"Zip": "97301",
"Phone": "5105552005",
"IsHidden": "false"
}
]
Field Descriptions:
Identification
- ClinicNum: Unique clinic identifier (integer). 0 = headquarters/main clinic. Use when creating appointments.
- Description: Clinic name displayed on statements, letters, and patient-facing documents.
- Abbr: Abbreviation for dropdowns and pick lists (e.g., "HQ", "Clinic1").
Physical Address
- Address, Address2: Street address.
- City, State, Zip: Location details.
- Phone: Clinic phone number (10 digits, no punctuation).
Billing Address
- BillingAddress, BillingCity, BillingState, BillingZip: Billing address for claims if different from physical.
- PayToAddress, PayToCity, PayToState, PayToZip: Address where insurance payments are sent.
Status
- IsHidden: "true" or "false". Hidden clinics are excluded from GET /clinics by default.
Usage Notes:
- • Use ClinicNum as ClinicNum when creating appointments
- • ClinicNum=0 is the headquarters (main/default clinic)
- • Clinics can be updated via PUT /clinics/{ClinicNum}
- • GET /clinics returns only non-hidden clinics; use ShortQuery for all