Job Allocations

Retrieve a Job Allocation

Changed on

OAuth Scope

This endpoint requires the following OAuth scope read_schedule.

get/joballocation/{uuid}.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/joballocation/{uuid}.json
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.servicem8.com/oauth/authorize
      Token URL: https://api.servicem8.com/oauth/access_token scopes: read_schedule

Path parameters

uuidstring uuid required

UUID of the Job Allocation

Response

Job Allocation record retrieved successfully

job_uuidstring uuid

The UUID of the job that this allocation relates to.

queue_uuidunknown
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.

estimated_durationunknown
revised_durationunknown
sort_prioritystring

The sort priority for displaying this job allocation.

requires_acceptanceunknown
acceptance_statusunknown
acceptance_timestampunknown
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

  • 638a8df09bf4Revision changes
    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

  • ca9b053c4373Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status