Skip to main content
GET
/
providers
Get Providers
curl --request GET \
  --url https://api.usecobalt.com/v1/providers \
  --header 'access_token: <api-key>' \
  --header 'client_id: <api-key>' \
  --header 'client_secret: <api-key>'
{
  "success": true,
  "providers": [
    {
      "ehr_id": "<string>",
      "name": "<string>",
      "timezone": "<string>",
      "hours": [
        {
          "day": "<string>",
          "shifts": [
            {
              "start": "<string>",
              "end": "<string>",
              "facility_id": "<string>",
              "recurrence": {
                "rec_start_date": "<string>",
                "recur_interval_type": "<string>",
                "recur_interval_amount": "<string>",
                "recur_interval_description": "<string>"
              },
              "set_end_date": "<string>",
              "facility_name": "<string>",
              "set_start_date": "<string>",
              "set_description": "<string>",
              "visit_type_rules": [
                {
                  "end_time": "<string>",
                  "start_time": "<string>",
                  "total_visits": 123,
                  "visit_type_id": "<string>",
                  "visit_type_desc": "<string>"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

​
Example Request

curl -X GET https://api.usecobalt.com/v1/providers \
-H 'Content-Type: application/json' \
-H 'client_id: ci_live_198908HJDKJSH98789OHKJL' \
-H 'client_secret: cs_live_9827hofdsklOYYHJLJh' \
-H 'access_token: 493JKLHIU98789hLKH9HHJH'

​
Example Response

{
    "success": true,
    "providers": [
        {
            "ehr_id": "99999",
            "timezone": "America/Phoenix",
            "npi": "425345345",
            "name": "Doe, John",
            "hours": [
                {
                    "day": "Monday",
                    "shifts": [
                        {
                            "end": "T12:00:00",
                            "start": "T08:00:00",
                            "set_start_date": "2024-11-20",
                            "set_end_date": "2025-11-20",
                            "facility_id": "2",
                            "facility_name": "Acme Clinic",
                            "recurrence": {
                                "rec_start_date": "2024-11-20",
                                "recur_interval_type": "weeks",
                                "recur_interval_amount": 1,
                                "recur_interval_description": "Every 1 week."
                            },
                            "visit_type_rules": [
                                {
                                    "end_time": "13:45:00",
                                    "start_time": "13:00:00",
                                    "total_visits": 1,
                                    "visit_type_id": "NP",
                                    "visit_type_desc": "New Patient"
                                },
                            ]
                        },
                        {
                            "end": "T16:30:00",
                            "start": "T13:00:00"
                        }
                    ]
                },
            ]
        }
    ]
}

​
Response Parameters

​
Schedule Structure

  • Day: Specifies which day of the week the schedule applies to
  • Shifts: Array of work periods with:
    • Start/end times using 24-hour format. Times are in the clinic’s eCW instance’s timezone.
    • Facility information (name and ID)
    • Date range when the schedule is active (start date and optional end date. If there is no end date then the shift is active indefinitely).
  • Visit Type Rules (optional):
    • Pre-allocated slots for specific appointment types
    • Each slot has its own start/end times
    • Includes description and total allowed appointments
  • Recurrence (optional):
    • Defines repeating patterns (e.g., “every 2 weeks”)
    • Contains start date and interval information
    • Allows for schedules that don’t occur every week

Authorizations

​
client_id
string
header
required
​
client_secret
string
header
required
​
access_token
string
header
required

Response

200 - application/json

Successful response

​
success
boolean
​
providers
object[]
⌘I