Search clinics

Returns active clinics owned by the API token’s tenant within radiusMiles of the given coordinates or address, nearest first. An address without line1 matches clinics in its state and postal code instead, ordered by name. Filterable by service and location. Requires the clinic.search scope.

POST /api/v2/clinics/search

Search clinics

cURL

curl --request POST \
  --url https://api.stage.origin.one/api/v2/clinics/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "data": [
    {
      "address": {
        "city": "Seattle",
        "country": "US",
        "line1": "123 Main St",
        "line2": "Suite 400",
        "object": "address",
        "postalCode": "98101",
        "state": "WA"
      },
      "id": "42",
      "name": "Austin Downtown Clinic",
      "object": "clinic",
      "phone": "[phone]",
      "coordinates": {
        "lat": 30.2672,
        "long": -97.7431
      },
      "isActive": true,
      "services": [
        {
          "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
          "name": "5 Panel Urine Drug Screen",
          "object": "service",
          "type": "labBasedToxicology",
          "url": "/api/v2/services/a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"
        }
      ],
      "url": "/api/v2/clinics/42",
      "distance": {
        "miles": 1.8
      }
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 1
}

Authorizations

Authorization · string · header · required

Origin One API token. Pass it in the Authorization header: Authorization: Bearer <token>.

Body

application/json

limit · integer string

Number of items per page (max 20).

Required range: 1 <= x <= 20

Example:

10

page · integer string

Page of results to return (1-based).

Required range: 1 <= x <= 10000

Example:

1

address · object

Search origin as a postal address; send this or coordinates, not both. Without line1, matches clinics in the same state and postal code, ordered by name, and radiusMiles does not apply.

Show child attributes

coordinates · object

Search origin as a point; send this or address, not both.

Show child attributes

locationId · string

Only clinics assigned to this location. A location outside the API token’s access returns an empty page.

Example:

"123"

radiusMiles · number string

Search radius from the origin, in miles (max 150).

Required range: 1 <= x <= 150

Example:

25

serviceIds · string[]

Only clinics that offer every one of these services.

Minimum array length: 1

Unique identifier of a service.

Response

200

application/json

Success.

data · object[] · required

Items on this page.

Show child attributes

limit · integer · required

Number of items per page.

Example:

10

page · integer · required

Current page number (1-based).

Example:

1

total · integer · required

Number of matching items across all pages.

Example:

1