---
title: "Get scheduling assistant suggestions"
method: GET
path: "/v1/jobs/schedulingAssistant"
tags: ["Jobs"]
---

# Get scheduling assistant suggestions

`GET /v1/jobs/schedulingAssistant`

## Request

- Base URL: `https://api.bigchange.com`
- URL: `https://api.bigchange.com/v1/jobs/schedulingAssistant`
- Auth: HTTP bearer

Suggests candidate resources or vehicles and time slots for scheduling a job. Returns suggestions only - use PUT /v1/jobs/{jobId}/schedule to act on one (required scope jobs:read)

## Query parameters

- `schedulingType` 'resources' | 'vehicles': The type of entity to find scheduling suggestions for<p>Possible values:</p><ul><li><b>resources</b>: Suggest resources</li><li><b>vehicles</b>: Suggest vehicles</li></ul>
- `latitude` number, double
- `longitude` number, double
- `fromDate` string, date-time
- `toDate` string, date-time
- `when` 'anytime' | 'morning' | 'afternoon' | 'custom': The time-of-day period to restrict scheduling suggestions to<p>Possible values:</p><ul><li><b>anytime</b>: Any time of day</li><li><b>morning</b>: The morning period</li><li><b>afternoon</b>: The afternoon period</li><li><b>custom</b>: A custom period, defined by whenFrom and whenTo</li></ul>
- `whenFrom` string, date-span
- `whenTo` string, date-span
- `jobId` integer
- `resourceId` integer
- `resourceGroupId` integer
- `vehicleId` integer
- `vehicleGroupId` integer
- `skillIds` integer[]
- `attributeIds` integer[]

## Headers

- `Customer-Id` integer, required

## Response `200`

OK

- SchedulingAssistantSuggestionsResponse: Represents a collection of scheduling assistant suggestions
  - `items` SchedulingAssistantSuggestionModel[]: The suggested resources or vehicles and time slots
    - `resourceId` integer, nullable: The unique identifier of the suggested resource, populated when scheduling by resource
    - `vehicleId` integer, nullable: The unique identifier of the suggested vehicle, populated when scheduling by vehicle
    - `resourceReference` string, nullable: The reference of the suggested resource or vehicle
    - `resourceName` string: The display name of the suggested resource, or the registration of the suggested vehicle
    - `resourceGroupName` string, nullable: The name of the resource or vehicle group the suggestion belongs to, if any
    - `skills` string[]: The names of the skills or attributes held by the suggested resource or vehicle
    - `startAt` string, date-time: The UTC start time of the suggested time slot
    - `extraDistanceKm` number, double: The additional travel distance, in kilometres, introduced by scheduling the job in this slot
    - `extraDrivingMinutes` integer: The additional driving time, in minutes, introduced by scheduling the job in this slot
    - `jobCost` number, double: The estimated cost of the job if scheduled in this slot
    - `averageDurationMinutes` integer, nullable: The average duration, in minutes, this resource takes to complete jobs of this type, when available
    - `successRatePercent` number, double, nullable: The percentage of jobs of this type this resource completes successfully, when available
    - `punctualityPercent` number, double, nullable: The percentage of jobs of this type this resource completes on time, when available

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `422`: Unprocessable Content
- `500`: Internal Server Error

## Changes

- **2026-09-03** `553de7d50a1c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/bigchange/apis/bigchange-dx/changes/v1/jobs/schedulingAssistant/get.md)

---

[API](https://skmtc.dev/bigchange/apis/bigchange-dx.md) - [All operations](https://skmtc.dev/bigchange/apis/bigchange-dx/llms.txt) - [OpenAPI document](https://skmtc.dev/bigchange/apis/bigchange-dx/revisions/b262bfdb1dd0?raw)