Skip to main content
GET
/
establishments
/
v2
/
bo
/
{establishmentId}
Get establishment
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/establishments/v2/bo/{establishmentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": {
    "id": 1,
    "address": "123 Main Street",
    "city": "Paris",
    "zipCode": 75001,
    "country": "France",
    "classifications": [
      "ERT",
      "ERP"
    ],
    "category": 3,
    "isGroupment": true,
    "totalSurfaceArea": 1500,
    "publicCapacity": 300,
    "privateCapacity": 50,
    "organizationId": 10,
    "establishmentSiteId": 5,
    "pinCode": 1234,
    "pinCodeEnabled": false,
    "onboardingStatus": "COMPLETED",
    "accessInstructions": "Enter through the back door.",
    "name": "Main site",
    "types": [
      1,
      1
    ],
    "serialNumber": "123456",
    "description": "This is the main site of the establishment.",
    "createdAt": "2023-01-01T08:00:00.000Z",
    "metadata": {
      "leafletDispatched": true
    },
    "presignedUrl": "https://example.com/presigned-url",
    "nbSites": 4,
    "nbQRCodes": 10,
    "organization": {
      "id": 1,
      "name": "Organization Name",
      "createdAt": "2024-12-01T12:34:56.000Z"
    },
    "createdBy": {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe"
    },
    "updatableFields": {
      "name": true,
      "description": true,
      "serialNumber": true,
      "address": true,
      "city": true,
      "zipCode": true,
      "country": true,
      "classifications": true,
      "category": true,
      "onboardingStatus": true,
      "leafletDispatched": true,
      "pinCode": true,
      "types": 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"

Path Parameters

establishmentId
integer
required

Unique identifier of the establishment.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

Response

200 - application/json

Establishment retrieved successfully

data
object
required