Skip to main content
GET
/
establishments
/
v2
/
rs
/
{establishmentId}
Get establishment with extensions
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/establishments/v2/rs/{establishmentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-Session-Token: <x-session-token>'
{
  "data": {
    "id": 1,
    "address": "123 Main Street",
    "city": "Paris",
    "zipCode": 75001,
    "country": "France",
    "classifications": [
      0,
      2
    ],
    "category": 3,
    "isGroupment": true,
    "totalSurfaceArea": 1500,
    "publicCapacity": 300,
    "privateCapacity": 50,
    "organizationId": 10,
    "establishmentSiteId": 5,
    "pinCode": 1234,
    "pinCodeEnabled": false,
    "accessInstructions": "Enter through the back door.",
    "name": "Main site",
    "types": [
      1,
      1
    ],
    "sites": [
      {
        "id": 1,
        "name": "Main site",
        "types": [
          1,
          1
        ],
        "serialNumber": "123456"
      }
    ],
    "tags": [
      {
        "id": 1,
        "name": "at the office",
        "color": "#FF5733",
        "type": {
          "id": 1,
          "name": "brands",
          "type": 1
        }
      }
    ],
    "presignedUrl": "https://example.com/presigned-url",
    "updatableFields": {
      "address": true,
      "city": true,
      "zipCode": true,
      "country": true,
      "classifications": true,
      "category": true,
      "isGroupment": true,
      "totalSurfaceArea": true,
      "publicCapacity": true,
      "privateCapacity": true,
      "img": true,
      "pinCodeEnabled": true,
      "accessInstructions": true,
      "metadata": true
    },
    "actions": {
      "canBeUpdated": true,
      "canBeDeleted": true
    }
  }
}

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.

Example:

1

Response

200 - application/json

Establishment retrieved successfully

data
object
required