Skip to main content
GET
/
establishments
/
v2
/
rs
/
{establishmentId}
/
buildings
/
{buildingId}
Get building by ID
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/establishments/v2/rs/{establishmentId}/buildings/{buildingId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-Session-Token: <x-session-token>'
{
  "data": {
    "id": 1,
    "name": "Main Building",
    "actions": {
      "canBeUpdated": true,
      "canBeDeleted": true
    },
    "updatableFields": {
      "name": true,
      "siteId": true
    },
    "site": {
      "id": 1,
      "name": "Main site",
      "serialNumber": "123456",
      "archivedAt": "2024-12-10T10:00:00.000Z"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Session-Token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

​
Content-Type
enum<string>
required

Content type, must be "application/json".

Available options:
application/json

Path Parameters

​
establishmentId
integer
required

Unique identifier of the establishment to which the building belongs.

Example:

1

​
buildingId
integer
required

Unique identifier of the building.

Example:

1

Query Parameters

​
extend
enum<string>[]

Extend options:

  • "actions-info": Give information about the origin of the building

  • "updatable-fields": Get information about the field that can be updated

  • "site": Get the site of the building

Available options:
actions-info,
updatable-fields,
site

Response

200 - application/json

Building retrieved successfully

​
data
object
required