Skip to main content
GET
Get one community or area

Authorizations

Authorization
string
header
required

The access_token returned by POST /oauth2/token, sent as Authorization: Bearer <access_token>. It is an opaque string, not a JWT.

Path Parameters

id
string<uuid>
required

Location UUID.

Response

Location

One node of the community / area tree, trimmed for public use.

id
string<uuid>
name
string

The leaf name. This is the value to send as a lead's areaOfInterest — but see path: names are NOT unique, and a name matching more than one node cannot be matched to a lead and comes back in intakeUnresolved.

Example:

"Dubai Marina"

level
string | null

Depth in the tree, as a string.

Example:

"2"

path
string

Full ancestry, for telling two similarly named areas apart in a picker.

Example:

"Ajman, Al Zorah, Marina"