Skip to main content
GET
/
api
/
area
/
{id}
Retrieves a single area by its identifier.
curl --request GET \
  --url https://{install}/api/area/{id} \
  --header 'Authorization: Bearer <token>'
{
  "entity": "<string>",
  "name": "<string>",
  "description": "<string>",
  "owner": 123,
  "ownerId": "<string>",
  "archived": true,
  "parentId": "<string>",
  "sequence": 123,
  "tenantId": "<string>",
  "id": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "updated": "2023-11-07T05:31:56Z",
  "updatedBy": "<string>",
  "deleted": true
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.

Path Parameters

​
id
string
required

The unique identifier of the area.

Response

The area.

​
entity
null | string
​
name
string
​
description
string
​
owner
integer
​
ownerId
string
​
archived
boolean
​
parentId
string
​
sequence
integer<int32>
​
tenantId
string
​
id
string
​
created
string<date-time>
​
createdBy
string
​
updated
string<date-time>
​
updatedBy
string
​
deleted
boolean