Skip to main content
GET
List locations

Understanding Location IDs

Each location has two identifiers:
  • id: Cobalt’s internal identifier (32-character UUID without hyphens)
    • Use when updating location settings like status
    • Operations: PATCH /v1/locations/{id}
  • ehr_id: Your EMR system’s location identifier
    • Use when creating appointments or other EMR operations
    • Operations: POST /v1/appointments (location field)
Why two IDs? Different operations work in different contexts. Location management (updating status) modifies Cobalt’s cached configuration, while appointment creation communicates directly with your EMR. Cobalt uses its own IDs to manage location settings independently of EMR constraints, then maps to EMR IDs when interacting with your EMR system.
Quick Reference:
  • Updating location settings → Use id
  • Creating appointments → Use ehr_id

Example Request

Example Response

Authorizations

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

Query Parameters

page
integer
default:1

Accepted for compatibility but ignored — every location is returned.

Required range: x >= 1
page_size
integer

Accepted for compatibility but ignored — every location is returned.

Required range: x >= 1

Response

Locations for the account

success
boolean
required
locations
object[]
required