Jobs

Retrieve a Job

Changed on

OAuth Scope

This endpoint requires the following OAuth scope read_jobs.

get/job/{uuid}.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/job/{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_jobs

Path parameters

uuidstring uuid required

UUID of the Job

Response

Job record retrieved successfully

created_by_staff_uuidstring uuid

UUID of the staff member who created this job. Records which staff member initially added the job to the system.

datestring

The date the job was created or scheduled. Used for organizing jobs chronologically and for reference in reports.

company_uuidstring uuid

UUID reference to the client/company record associated with this job. Links the job to a client in the system, establishing the client-job relationship for billing and contact purposes.

billing_addressstring

The address where invoices and billing information should be sent. If not specified, defaults to the job address.

status'Quote' | 'Work Order' | 'Unsuccessful' | 'Completed' required

Current status of the job. Controls where the Job appears in the Dispatch Board.. Valid values are [Quote,Work Order,Unsuccessful,Completed]

lngnumber float

The longitude coordinate of the job location. (Read only)

latnumber float

The latitude coordinate of the job location. (Read only)

payment_datestring

Not used. Refer to JobPayment endpoint.

payment_actioned_by_uuidstring uuid

Not used. Refer to JobPayment endpoint.

payment_methodstring

Not used. Refer to JobPayment endpoint.

payment_amountstring

Not used. Refer to JobPayment endpoint.

category_uuidstring uuid

UUID reference to the job category this job belongs to. Categories help organize jobs by type of work or department.

payment_notestring

Not used. Refer to JobPayment endpoint.

geo_is_valid0 | 1

Indicates whether the geocoding for the job address is valid. If this is false, the lat, lng, and other geo_ fields should not be used. (Read only). Valid values are [0,1]

purchase_order_numberstring

Client purchase order reference number for this job. Used for cross-referencing with external accounting or order management systems.

invoice_sent0 | 1

Indicates whether an invoice has been sent for this job.. Valid values are [0,1]

invoice_sent_stampstring

The date and time when the invoice was sent. (Read only)

ready_to_invoiceunknown
ready_to_invoice_stampunknown
geo_countrystring

The country field of the job address. (Read only)

geo_postcodestring

The postcode/ZIP code field of the job address. (Read only)

geo_statestring

The state/province field of the job address. (Read only)

geo_citystring

The city/suburb field of the job address. (Read only)

geo_streetstring

The street name field of the job address. (Read only)

geo_numberstring

The street number field of the job address. (Read only)

queue_uuidstring uuid

The UUID of the queue this job belongs to.

queue_expiry_datestring

The date and time when the job expires from the queue.

queue_assigned_staff_uuidstring uuid

The UUID of the staff member assigned to this job in the queue.

badgesstring

JSON Array of Badge UUIDs

quote_datestring

The date and time that the job status was changed to Quote.

quote_sent0 | 1

Boolean flag indicating whether a quote has been sent to the client for this job.. Valid values are [0,1]

quote_sent_stampstring

Timestamp when the quote was sent to the client. Format is YYYY-MM-DD HH:MM:SS. (Read only)

work_order_datestring

The date and time that the job status was changed to Work Order.

active_network_request_uuidunknown
related_knowledge_articlesunknown
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

job_addressstring

Physical address where the job is to be performed. This address is used for geocoding to place the job on the map.

job_descriptionstring
work_done_descriptionstring

Email Address

generated_job_idstring

System-generated unique job identifier. This is read-only and automatically assigned when a job is created. (Read only)

total_invoice_amountstring

The total amount to be invoiced for this job. (Read only)

payment_processed0 | 1

Indicates whether the job has been exported to the connected Accounting Package.. Valid values are [0,1]

payment_processed_stampstring

The date and time the job has been exported to the connected Accounting Package. (Read only)

payment_received0 | 1

Indicates whether full payment has been received for this job.. Valid values are [0,1]

payment_received_stampstring

The date and time when full payment was received. (Read only)

completion_datestring

The date and time that the job status was changed to Completed.

completion_actioned_by_uuidstring uuid

UUID of the staff member who marked this job as completed. References a staff record in the system. (Read only)

unsuccessful_datestring

The date and time that the job status was changed to Unsuccessful.

job_is_scheduled_until_stampstring

The end date/time of the last scheduled activity for this job. After this date, the job is considered Unscheduled. (Read only)

Example response

{
  "created_by_staff_uuid": "123e4567-23ec-4462-bee3-23f949ed284b",
  "date": "YYYY-MM-DD",
  "company_uuid": "123e4567-1e80-4b40-ae96-23f94a2e5b3b",
  "payment_date": "2026-03-01 12:00:00",
  "payment_actioned_by_uuid": "123e4567-764a-4868-9a03-23f94df4c6db",
  "category_uuid": "123e4567-3240-4ca3-9b58-23f94e0fc73b",
  "invoice_sent_stamp": "2026-03-01 12:00:00",
  "queue_uuid": "123e4567-48c4-42ab-8966-23f94bb4942b",
  "queue_expiry_date": "2026-03-01 12:00:00",
  "queue_assigned_staff_uuid": "123e4567-4ef4-4d41-859d-23f94831bd3b",
  "quote_date": "2026-03-01 12:00:00",
  "quote_sent_stamp": "2026-03-01 12:00:00",
  "work_order_date": "2026-03-01 12:00:00",
  "uuid": "123e4567-3be0-4db3-9ec1-23f94b16af9b",
  "edit_date": "2026-03-01 12:00:00",
  "payment_processed_stamp": "2026-03-01 12:00:00",
  "payment_received_stamp": "2026-03-01 12:00:00",
  "completion_date": "2026-03-01 12:00:00",
  "completion_actioned_by_uuid": "123e4567-39cc-4284-a77c-23f9428e6feb",
  "unsuccessful_date": "2026-03-01 12:00:00",
  "job_is_scheduled_until_stamp": "2026-03-01 12:00:00"
}

Changes

  • 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

  • f2e41074a468Revision changes
    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • warning

      added the new 0.00 enum value to the response property for the response status

    • warning

      added the new 0.00 enum value to the response property for the response status

    • warning

      added the new 0.00 enum value to the response property for the response status

    • warning

      added the new 0.00 enum value to the response property for the response status

    • warning

      added the new 1.00 enum value to the response property for the response status

    • warning

      added the new 1.00 enum value to the response property for the response status

    • warning

      added the new 1.00 enum value to the response property for the response status

    • warning

      added the new 1.00 enum value to the response property for the response status