Skip to main content
GET
/
admin
/
locations
/
list
List Locations
curl --request GET \
  --url https://api.decodahealth.com/admin/locations/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "data": [
    {
      "id": "<string>",
      "isVirtual": true,
      "name": "<string>",
      "timezone": "<string>",
      "addressLineOne": "<string>",
      "addressLineTwo": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode": "<string>",
      "country": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "spakinectLocationId": "<string>",
      "description": "<string>",
      "phoneNumber": "<string>",
      "photoUrl": "<string>",
      "reviewLink": "<string>",
      "updatedDate": "2023-11-07T05:31:56Z",
      "latitude": 123,
      "longitude": 123,
      "taxes": []
    }
  ],
  "total": 123
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

page
integer | null
per_page
integer | null
sort_by
string | null
sort_direction
enum<string> | null
Available options:
asc,
desc
location_id
string | null
name
string | null
city
string | null
state
string | null
is_virtual
boolean | null

Response

Successful Response

data
LocationDetail · object[]
required
total
integer
required