Skip to main content
GET
/
buildings
/
v1
/
ad
List buildings with filters pagination
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/buildings/v1/ad \
  --header 'Authorization: Bearer <token>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": [
    {
      "id": 1,
      "name": "Main Building",
      "projectId": 1,
      "updatedAt": "2024-12-05T14:56:23.000Z",
      "createdAt": "2024-01-15T08:45:00.000Z",
      "plans": [
        {
          "id": 1,
          "name": "Main Plan",
          "code": "main-plan",
          "actions": {
            "canBeUpdated": true,
            "canBeDeleted": true
          }
        }
      ],
      "updatableFields": {
        "name": true,
        "siteId": true
      },
      "actions": {
        "canBeUpdated": true,
        "canBeDeleted": true
      }
    }
  ],
  "totalCount": 100,
  "pagination": {
    "page": 1,
    "pageSize": 50
  }
}

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"

Query Parameters

​
extend
enum<string>[]

Extend options:

  • "plans": Get the plans linked to the buildings

  • "plans-actions-infos": Give information about actions that can be done on the plan

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

  • "actions-info": Give information about the origin of the building (commission or intervention)

Available options:
plans,
plans-actions-infos,
updatable-fields,
actions-info
​
whereProjectId
integer

Filter by project ID

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

1

​
whereName
string

Filter by building name

Example:

"string"

​
whereCreatedAt
string

Filter by createdAt date

Example:

"2021-01-01T00:00:00.000Z"

​
whereHasFloor
boolean

Filter by buildings with or without plans

Example:

true

​
orderBy
object[]
​
wherePlanName
string

Filter by plan name

Example:

"string"

​
wherePlanBuildingId
integer[]

Filter by building ID

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
wherePlanBuildingName
string

Filter by building name

Example:

"string"

​
wherePlanHasDocument
boolean

Filter by presence of document

Example:

true

​
wherePlanDocumentName
string

Filter by document name

Example:

"string"

​
wherePlanHasLayers
boolean

Filter by presence of layers

Example:

true

​
wherePlanLayerIds
integer[]

Filter by layer IDs

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
wherePlanHasItems
boolean

Filter by presence of plan items

Example:

true

​
wherePlanItemIds
integer[]

Filter by plan item IDs

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
wherePlanCreatedAt
string

Filter by createdAt date

Example:

"2021-01-01T00:00:00.000Z"

​
wherePlanUpdatedAt
string

Filter by updatedAt date

Example:

"2021-01-01T00:00:00.000Z"

​
whereText
string

Filter by global text search

Example:

"string"

​
includeCount
boolean
default:false

Include total count in response.

Example:

true

​
page
integer
default:1

Page number.

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

1

​
pageSize
integer
default:50

Page size.

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

50

​
findId
integer

Get the page where the item with this id is located.

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

1

​
subPageSize
integer
default:10

Sub page size for grouping items.

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

10

Response

200 - application/json

Buildings retrieved successfully

​
data
object[]
required
​
totalCount
integer

Total count of items.

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

100

​
pagination
object

Pagination information.