Locations endpoints

List externally serviceable collection locations

Only active locations in the service geography of the active programs this key is granted, in the current environment. Street address, telephone and internal operational detail are never returned.

Authentication & scope

• Authentication: Authorization: Bearer <API key>. The key is bound to one laboratory, one API client and one environment.
• Required scope: serviceability:read. A key without it is refused with 403 forbidden.

Synthetic schema examples are illustrative, not eligible records. Set PROGRAM_ID and ITEM_ID from granted Programs/Catalog, ORDER_ID and RESULT_ID from current responses, and EXTERNAL_SUBJECT_ID to an opaque synthetic reference. Replace body identifiers with authorized records and include patient/provider/question fields only when current requirements request them. Use Sandbox; Production requires separate approval.

cURL

curl -s "$SOLIA_API_BASE/locations" \
  -H "Authorization: Bearer $SOLIA_API_KEY"

Responses

• 200 — Serviceable locations.
• 401 — Missing, invalid, revoked or expired key.
• 403 — The key lacks serviceability:read.
• 429 — Per-instance client rate limit exceeded; honor Retry-After.
• 500 — Canonical request failed; reconcile uncertain actions.
• 503 — Required API configuration is unavailable.

{
  "data": [
    {
      "location_id": "00000000-0000-4000-8000-000000000001",
      "location_code": "synthetic",
      "name": "synthetic",
      "region": "synthetic",
      "city": "synthetic",
      "country": "synthetic",
      "timezone": "synthetic",
      "collection_methods": [
        "synthetic"
      ],
      "appointment_required": true,
      "walk_in_allowed": true,
      "service_status": "active"
    }
  ],
  "request_id": "synthetic"
}