Skip to main content
GET
/
commissions
/
v2
/
rs
List commissions with filters pagination
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/commissions/v2/rs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-Session-Token: <x-session-token>'
{
  "data": [
    {
      "id": 1,
      "visitType": 1,
      "commissionType": 1,
      "status": 1,
      "decision": 1,
      "commissionDate": "2024-12-01T12:34:56.000Z",
      "buildingWorkId": 1,
      "comment": "Urgent repairs needed.",
      "createdById": 1,
      "updatedAt": "2024-12-09T14:23:00.000Z",
      "createdAt": "2024-01-15T08:45:00.000Z",
      "createdBy": {
        "id": 1,
        "firstName": "John",
        "lastName": "Doe"
      },
      "report": {
        "id": 1,
        "name": "Document Name",
        "presignedUrl": "https://bucket.s3.amazonaws.com/1"
      },
      "labels": [
        {
          "id": 1,
          "name": "Urgent",
          "color": "#FF5733"
        }
      ],
      "signatureUrl": "Signature URL",
      "signedBy": "Signatory",
      "signedDate": "2024-12-01T12:34:56.000Z",
      "presignedUrl": "https://example.com/presigned-url",
      "buildingWork": {
        "id": 1,
        "description": "Building work description",
        "authorizationNumber": "Authorization number",
        "permitStatus": 1,
        "receptionDate": "2024-12-01T12:34:56.000Z",
        "archivedAt": "2024-11-20T10:30:00.000Z"
      }
    }
  ],
  "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"

​
Content-Type
enum<string>
required

Content type, must be "application/json".

Available options:
application/json
​
x-sites
string

List of site IDs.

Example:

"['1', '2']"

Query Parameters

​
extend
enum<string>[]

Extend options:

  • "created-by": Get information about the person that created the commission

  • "report": Get information about the report

  • "labels": Get the labels linked to the commission

  • "signature": Get the signature information for the commission

  • "building-works": Get the building works linked to the commission

Available options:
created-by,
report,
labels,
signature,
building-works
​
whereVisitType
integer[]

Filter by visit type

Example:
[1, 2, 3]
​
whereCommissionType
integer[]

Filter by commission type

Example:
[1, 2, 3]
​
whereStatus
integer[]

Filter by status

Example:
[1, 2, 3]
​
whereDecision
integer[]

Filter by decision

Example:
[1, 2, 3]
​
whereCommissionDate
object

Filter by commission date

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
whereComment
string

Filter by comment

Example:

"string"

​
whereSignedBy
string

Filter by signed by

Example:

"string"

​
whereSignedDate
object

Filter by signed date

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
whereBuildingWorkIds
integer[]

Filter by building work ids

Example:
[1, 2, 3]
​
whereSiteIds
integer[]

Filter by site ids

Example:
[1, 2, 3]
​
whereLabelIds
integer[]

Filter by label ids

Example:
[1, 2, 3]
​
whereCreatedByIds
integer[]

Filter by created by ids

Example:
[1, 2, 3]
​
whereArchivedAt
object

Filter by archived at

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
whereIsArchived
boolean

Filter by is archived

Example:

true

​
whereUpdatedAt
object

Filter by updated at

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
whereCreatedAt
object

Filter by created at

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
orderBy
object[]
​
includeCount
boolean
default:false

Include total count in response.

Example:

true

​
page
integer
default:1

Page number.

Example:

1

​
pageSize
integer
default:50

Page size.

Example:

50

​
findId
integer

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

Example:

1

​
subPageSize
integer
default:10

Sub page size for grouping items.

Example:

10

Response

200 - application/json

List of commissions

​
data
object[]
required
​
totalCount
integer

Total count of items.

Example:

100

​
pagination
object

Pagination information.