v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Installer Jobs

Retrieve a list of installer jobs

Required scope: installer-jobs:read

get/api/v1/installer-jobs

Query parameters

pageinteger

page number to retrieve (starts with 0)

perPageinteger

number of items per page (between 1 and 100, default 10)

fromstring date

Filter installer jobs created on or after this date (YYYY-MM-DD)

tostring date

Filter installer jobs created on or before this date (YYYY-MM-DD)

siteIdinteger nullable

Allows to filter list of installer jobs by a site id

Example:13

teamIdinteger nullable

Allows to filter list of installer jobs by a team id.

Example:19

includeDeletedboolean nullable

If true, deleted installer jobs will be included in the response.

Example:true

Response

List of installer jobs that match the criteria

Example response

{
  "data": [
    {
      "id": 42,
      "siteId": 22,
      "operator": {
        "id": 14,
        "name": "Monta",
        "identifier": "monta",
        "partnerId": 1,
        "vatNumber": "FOO-123-ABC"
      },
      "teamId": 4124,
      "description": "5",
      "publicLink": "https://app.monta.app/installer-page/149ffbb6-7b69-47a1-9698-90177c2027da",
      "chargePointCount": 5,
      "chargePointActiveCount": 3,
      "email": "installer@acme.org",
      "tasks": [
        {
          "id": 42,
          "installerJobId": 5,
          "chargePointId": 21,
          "serialNumber": "1",
          "connector": 1,
          "note": "1",
          "installerNote": "1",
          "activeAt": "2022-05-12T15:56:45.99Z",
          "createdAt": "2022-05-12T15:56:45.99Z",
          "updatedAt": "2022-05-12T15:56:45.99Z",
          "deletedAt": "2022-05-12T15:56:45.99Z"
        }
      ],
      "completedAt": "2022-05-12T15:56:45.99Z",
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": "2022-05-12T15:56:45.99Z",
      "deletedAt": "2022-05-12T15:56:45.99Z"
    }
  ]
}