--- title: "Retrieve a Job" method: GET path: "/job/{uuid}.json" tags: ["Jobs"] --- # Retrieve a Job `GET /job/{uuid}.json` #### OAuth Scope This endpoint requires the following OAuth scope **read_jobs**. ## Path parameters - `uuid` string, uuid, required ## Response `200` Job record retrieved successfully - Job - `created_by_staff_uuid` string, uuid — UUID of the staff member who created this job. Records which staff member initially added the job to the system. - `date` string — The date the job was created or scheduled. Used for organizing jobs chronologically and for reference in reports. - `company_uuid` string, 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_address` string — 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] - `lng` number, float — The longitude coordinate of the job location. (Read only) - `lat` number, float — The latitude coordinate of the job location. (Read only) - `payment_date` string — Not used. Refer to JobPayment endpoint. - `payment_actioned_by_uuid` string, uuid — Not used. Refer to JobPayment endpoint. - `payment_method` string — Not used. Refer to JobPayment endpoint. - `payment_amount` string — Not used. Refer to JobPayment endpoint. - `category_uuid` string, uuid — UUID reference to the job category this job belongs to. Categories help organize jobs by type of work or department. - `payment_note` string — Not used. Refer to JobPayment endpoint. - `geo_is_valid` 0 | 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_number` string — Client purchase order reference number for this job. Used for cross-referencing with external accounting or order management systems. - `invoice_sent` 0 | 1 — Indicates whether an invoice has been sent for this job.. Valid values are [0,1] - `invoice_sent_stamp` string — The date and time when the invoice was sent. (Read only) - `ready_to_invoice` unknown - `ready_to_invoice_stamp` unknown - `geo_country` string — The country field of the job address. (Read only) - `geo_postcode` string — The postcode/ZIP code field of the job address. (Read only) - `geo_state` string — The state/province field of the job address. (Read only) - `geo_city` string — The city/suburb field of the job address. (Read only) - `geo_street` string — The street name field of the job address. (Read only) - `geo_number` string — The street number field of the job address. (Read only) - `queue_uuid` string, uuid — The UUID of the queue this job belongs to. - `queue_expiry_date` string — The date and time when the job expires from the queue. - `queue_assigned_staff_uuid` string, uuid — The UUID of the staff member assigned to this job in the queue. - `badges` string — JSON Array of Badge UUIDs - `quote_date` string — The date and time that the job status was changed to Quote. - `quote_sent` 0 | 1 — Boolean flag indicating whether a quote has been sent to the client for this job.. Valid values are [0,1] - `quote_sent_stamp` string — Timestamp when the quote was sent to the client. Format is YYYY-MM-DD HH:MM:SS. (Read only) - `work_order_date` string — The date and time that the job status was changed to Work Order. - `active_network_request_uuid` unknown - `related_knowledge_articles` unknown - `uuid` string, uuid — Unique identifier for this record - `active` 0 | 1 — Record active/deleted flag. Valid values are [0,1] - `edit_date` string — Timestamp at which record was last modified - `job_address` string — Physical address where the job is to be performed. This address is used for geocoding to place the job on the map. - `job_description` string - `work_done_description` string — Email Address - `generated_job_id` string — System-generated unique job identifier. This is read-only and automatically assigned when a job is created. (Read only) - `total_invoice_amount` string — The total amount to be invoiced for this job. (Read only) - `payment_processed` 0 | 1 — Indicates whether the job has been exported to the connected Accounting Package.. Valid values are [0,1] - `payment_processed_stamp` string — The date and time the job has been exported to the connected Accounting Package. (Read only) - `payment_received` 0 | 1 — Indicates whether full payment has been received for this job.. Valid values are [0,1] - `payment_received_stamp` string — The date and time when full payment was received. (Read only) - `completion_date` string — The date and time that the job status was changed to Completed. - `completion_actioned_by_uuid` string, uuid — UUID of the staff member who marked this job as completed. References a staff record in the system. (Read only) - `unsuccessful_date` string — The date and time that the job status was changed to Unsuccessful. - `job_is_scheduled_until_stamp` string — The end date/time of the last scheduled activity for this job. After this date, the job is considered Unscheduled. (Read only) ## Other responses - `400` — Bad Request - The request is malformed or contains invalid parameters - `401` — Unauthorized - Authentication credentials are missing or invalid - `403` — Forbidden - You don't have permission to access this resource - `404` — Not Found - The requested record does not exist or has been deleted - `429` — Too Many Requests - You have exceeded the rate limit - `500` — Internal Server Error - An unexpected error occurred on the server --- [API](https://skmtc.net/servicem8/apis/servicem8-api.md) · [All operations](https://skmtc.net/servicem8/apis/servicem8-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/servicem8/servicem8-api/revisions/53ede60e3653/schema)