Skip to main content
GET
/
locations
Get Locations
curl --request GET \
  --url https://api.roostedhr.com/api/1_12/locations \
  --header 'X-API-KEY: <api-key>'
{
  "locations": [
    {
      "id": "<string>",
      "location": "<string>",
      "addy_street_number": "<string>",
      "addy_city": "<string>",
      "addy_zip": "<string>",
      "location_comments": "<string>",
      "default": 0,
      "saved": 0,
      "color": "#DC136C",
      "timezone": {
        "id": 123,
        "name": "<string>",
        "offset": "<string>"
      },
      "companies_payroll_rulesets_id": "<string>",
      "payroll_rule_display": "<string>",
      "latitude": "<string>",
      "longitude": "<string>",
      "default_clients_id": "<string>",
      "default_areas": [
        "<string>"
      ]
    }
  ],
  "total": 123
}
This endpoint returns paginated results. Use items_per_page and page query parameters to control pagination. The response includes a total field with the full count of locations.

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
items_per_page
integer

Number of items per page (1-100). Defaults to 25.

Required range: 1 <= x <= 100
​
page
integer

Page number. Defaults to 1.

Required range: x >= 1

Response

OK

​
locations
Location · object[]
​
total
integer

Total number of locations