Jobs

Get the schedule board's jobs for a day

Changed on

Retrieve a paged collection of the scheduled jobs that overlap one day in the user's time zone, completed jobs included, for the schedule board's rows. A job appears once for its resource and once for each assistant. The user's resource, vehicle and job category restrictions are applied. Ordered by planned start. Requires the user to have the right to view allocated jobs (required scope jobs:read)

get/v1/jobs/board

Request

  • Base URL
    https://api.bigchange.com
  • Auth
    HTTP bearer

Query parameters

datestring date
Example:2026-11-04

The day to return, in the user's time zone. Jobs that overlap any part of it are returned

useActualTimesboolean

Choose the day's jobs by their actual times where the device has recorded them, and planned times otherwise, as the classic board's actual-times view does. By default, jobs are chosen by their planned times

resourceIdinteger[]

Only return the rows of the resources where resourceId matches the value(s) provided, including jobs they assist on (Max items: 50)

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "items": [
    {
      "jobId": 168797769,
      "resourceId": 5514123,
      "plannedStartAt": "2026-11-04T09:00:00.0000000+00:00",
      "plannedDurationMinutes": 90,
      "actualStartAt": "2026-11-04T09:05:00.0000000+00:00",
      "actualEndAt": "2026-11-04T10:40:00.0000000+00:00",
      "plannedTravelMinutes": 25,
      "plannedReturnTravelMinutes": 30,
      "actualTravelMinutes": 27
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}

Changes