Skip to main content
GET
/
areas
Get Areas
curl --request GET \
  --url https://api.roostedhr.com/api/1_12/areas \
  --header 'X-API-KEY: <api-key>'
[
  {
    "id": "a1B2c",
    "name": "Northeast",
    "parent_id": "",
    "nlevel": 0,
    "protected": false
  },
  {
    "id": "d3E4f",
    "name": "New York City",
    "parent_id": "a1B2c",
    "nlevel": 1,
    "protected": false
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.roostedhr.com/llms.txt

Use this file to discover all available pages before exploring further.

Areas represent geographic or organizational regions used to group locations, workers, and events. They support a parent-child hierarchy — each area can optionally reference a parent_id to nest under another area.
The response returns a flat list of all areas. Use the parent_id and nlevel fields to reconstruct the hierarchy on the client side.

Authorizations

​
X-API-KEY
string
header
required

Response

OK

​
id
string

Unique area identifier.

Example:

"a1B2c"

​
name
string

Display name of the area.

Example:

"Northeast"

​
parent_id
string

Parent area ID, or empty string if top-level.

Example:

""

​
nlevel
integer

Nesting depth (0 = top-level).

Example:

0

​
protected
boolean

Whether the area is system-protected.

Example:

false