Sign in
Job Allocations

List all Job Allocations

Filtering

This endpoint supports result filtering. For more information on how to filter this request, go here.

OAuth Scope

This endpoint requires the following OAuth scope read_schedule.

get/joballocation.json

Response

An array of Job Allocations

job_uuidstring uuid

The UUID of the job that this allocation relates to.

{"stackTrail":"components:schemas:JobAllocation:properties:queue_uuid","oasType":"schema","type":"unknown","description":"DEPRECATED"}
staff_uuidstring uuid

The UUID of the staff member this job is allocated to.

allocation_datestring

The minimum start date for a job allocation to be completed by a staff member. Setting this date will ensure the job allocation appears in the future on staff schedules.

allocation_window_uuidstring uuid

The UUID of the allocation window that defines when the job should be completed (e.g. Urgent, Early Morning, During Business Hours).

allocated_by_staff_uuidstring uuid

The UUID of the staff member who allocated the job.

allocated_timestampstring

The timestamp when the job was allocated.

expiry_timestampstring

The timestamp when the job allocation expires.

read_timestampstring

The timestamp when the job allocation was read by the staff member.

completion_timestampstring

The timestamp when the job allocation was marked as completed.

{"stackTrail":"components:schemas:JobAllocation:properties:estimated_duration","oasType":"schema","type":"unknown","description":"DEPRECATED"}
{"stackTrail":"components:schemas:JobAllocation:properties:revised_duration","oasType":"schema","type":"unknown","description":"DEPRECATED"}
sort_prioritystring

The sort priority for displaying this job allocation.

{"stackTrail":"components:schemas:JobAllocation:properties:requires_acceptance","oasType":"schema","type":"unknown","description":"DEPRECATED"}
{"stackTrail":"components:schemas:JobAllocation:properties:acceptance_status","oasType":"schema","type":"unknown","description":"DEPRECATED"}
{"stackTrail":"components:schemas:JobAllocation:properties:acceptance_timestamp","oasType":"schema","type":"unknown","description":"DEPRECATED"}
uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

Example response

[
  {
    "job_uuid": "123e4567-796e-43d3-89b8-23f942b7f0ab",
    "staff_uuid": "123e4567-4525-400b-ab3e-23f94473c62b",
    "allocation_date": "2026-03-01 12:00:00",
    "allocation_window_uuid": "123e4567-7fd1-45f3-8068-23f945565e9b",
    "allocated_by_staff_uuid": "123e4567-c873-4cca-91e7-23f943de293b",
    "allocated_timestamp": "2026-03-01 12:00:00",
    "expiry_timestamp": "2026-03-01 12:00:00",
    "read_timestamp": "2026-03-01 12:00:00",
    "completion_timestamp": "2026-03-01 12:00:00",
    "uuid": "123e4567-8160-4f2d-951a-23f94c5382cb",
    "edit_date": "2026-03-01 12:00:00"
  }
]

Changes

Changed in 2 of the 50 revisions of this API.64

  • 638a8df09bf46See the full diff
    • ▲

      the items/acceptance_status response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      the items/acceptance_timestamp response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      the items/estimated_duration response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      the items/queue_uuid response's property type/format changed from string/uuid to / for status 200

      response-property-type-changed

    • ▲

      the items/requires_acceptance response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      the items/revised_duration response's property type/format changed from string/ to / for status 200

      response-property-type-changed

  • ca9b053c43734See the full diff
    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added