Skip to main content
GET
/
v1
/
au
/
locations
Get a paged list of locations
curl --request GET \
  --url https://api.halth.com/v1/au/locations \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "minorId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "page": 1,
  "limit": 10,
  "totalItems": 100,
  "totalPages": 10
}

Authorizations

​
Authorization
string
header
required

Provide your API key as a Bearer token

Query Parameters

​
page
number
default:1

Page number

Required range: 1 <= x <= 9007199254740991
Example:

1

​
limit
number
default:10

Number of items per page

Required range: 1 <= x <= 200
Example:

10

Response

200 - application/json
​
items
object[]
​
page
number
Example:

1

​
limit
number
Example:

10

​
totalItems
number
Example:

100

​
totalPages
number
Example:

10