Skip to main content
GET
/
plans
/
v1
/
ad
List all plans
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/plans/v1/ad \
  --header 'Authorization: Bearer <token>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": [
    {
      "id": 1,
      "name": "Main Plan",
      "code": "main-plan",
      "buildingId": 1,
      "createdAt": "2024-01-15T08:45:00.000Z",
      "updatedAt": "2024-12-05T14:56:23.000Z",
      "actions": {
        "canBeUpdated": true,
        "canBeDeleted": true
      },
      "document": {
        "id": 1,
        "presignedUrl": "https://example.com/presigned-url"
      },
      "updatableFields": {
        "name": true,
        "documentId": true,
        "siteId": true,
        "code": 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:

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

  • "document": Add the presigned URL for the document

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

Available options:
actions-info,
document,
updatable-fields
​
whereName
string

Filter by plan name

Example:

"string"

​
whereBuildingId
integer

Filter by building ID

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

1

​
whereCreatedAt
string

Filter by createdAt date

Example:

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

​
orderBy
object[]
​
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

Plans retrieved successfully

​
data
object[]
required
​
totalCount
integer

Total count of items.

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

100

​
pagination
object

Pagination information.