Skip to main content
GET
/
commissions
/
v1
{
  "data": [
    {
      "buildingWorkId": 123,
      "commissionDate": "2024-12-01T12:34:56.000Z",
      "commissionType": 123,
      "createdAt": "2024-12-01T12:34:56.000Z",
      "createdById": 123,
      "decision": 123,
      "id": 123,
      "signatureUrl": "",
      "signedBy": 123,
      "signedDate": "2024-12-01T12:34:56.000Z",
      "siteId": 123,
      "comment": "Urgent",
      "status": 123,
      "updatedAt": "2024-12-01T12:34:56.000Z",
      "visitType": 123
    }
  ],
  "totalCount": 42,
  "pagination": {
    "page": 1,
    "pageSize": 10,
    "elementIdxInPage": 2,
    "findId": 123
  }
}

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
number
required

Site IDs associated with the commissions.

Query Parameters

​
includeEditInfo
boolean
required

Indicates whether to include additional details on modifications to the anomaly entries.

Example:

true

​
includeSite
boolean
required

Specifies if the site information associated with the log should be included.

Example:

true

​
includeReport
boolean
required

Specifies whether the report information associated with the anomaly should be included or not.

Example:

true

​
includeBuildingWork
boolean
required

Indicates whether to include building work related information.

Example:

true

​
includeCreatedBy
boolean
required

Indicates whether to include the creator details of the commission.

Example:

true

​
filterVisitType
required

Filters commissions by visit type. Example types: VR, VRP, VP.

Available options:
VR
Example:

"VP"

​
filterStatus
string
required

Filters commissions by their status. Example: "approved", "pending".

Example:

""

​
filterDecision
string
required

Filters commissions based on their decision. Example: "accepted", "rejected".

Example:

""

​
filterCommissionType
string
required

Filters commissions by their type. Example: "survey", "inspection".

Example:

""

​
pageSize
number
required

Number of entries per page. Controls pagination size for large result sets.

Required range: x > 0
Example:

10

​
page
number
required

Specifies the page of results to return in paginated queries.

Required range: x > 0
Example:

1

​
includeTotalCount
boolean
required

Specifies whether to include the total count of entries in the response, useful for determining the total available pages.

Example:

true

​
includeSignature
boolean
required

Specifies whether to include the signature information related to the commission.

Example:

true

Response

200 - application/json

Successfully retrieved the list of commissions.

​
data
object[]
required
​
totalCount
number | null

Total count of entries, if requested.

Example:

42

​
pagination
object