Skip to content
Docs
Select language:English

/api/v1/locations/{locationId}/places (GET)

GET
/api/v1/locations/{locationId}/places
curl --request GET \
  --url https://example.com/api/v1/locations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/places \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
places
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
parentId
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
kindKey
required
string
icon
required
string | null
sort
required
integer
>= -9007199254740991 <= 9007199254740991
isUnplaced
required
boolean
shortCode
required
string | null
thingCount
required
integer
>= -9007199254740991 <= 9007199254740991
childCount
required
integer
>= -9007199254740991 <= 9007199254740991
Examplegenerated
{
  "places": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "parentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "kindKey": "example",
      "icon": "example",
      "sort": 1,
      "isUnplaced": true,
      "shortCode": "example",
      "thingCount": 1,
      "childCount": 1
    }
  ]
}