Solia Direct DocsControl Plane
⌘K

API ReferenceReference

Locations endpoints

Exact request and response contracts for the locations endpoints, generated from the enforced Partner API contract.

Machine-readable OpenAPI description

Endpoints in this group

GET/v1/locationsList externally serviceable collection locations

Base path: /api/public/partner/v1. Every response carries request_id; every failure uses the standard error envelope documented under Errors.

GET/v1/locations

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.

Responses

  • 200 — Serviceable locations.
  • 403 — The key lacks serviceability:read.
json
{
  "data": [
    {
      "location_id": "8f14e45f-ceea-4c2b-9b3f-2a1d0c7b6a11",
      "location_code": "string",
      "name": "string",
      "region": "string",
      "city": "string",
      "country": "string",
      "timezone": "string",
      "collection_methods": [
        "string"
      ],
      "appointment_required": true,
      "walk_in_allowed": true,
      "service_status": "active"
    }
  ],
  "request_id": "string",
  "cursor": "string"
}