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

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

Unique area identifier.

Example:

"a1B2c"

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