---
updatedAt: 2026-07-01T11:37:16.000Z
agentTools:
  projectIndex: https://developer.servicem8.com/llms.txt
---

# Retrieve a Job Checklist


			
#### OAuth Scope
This endpoint requires the following OAuth scope **read_job_checklists**.

			

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "ServiceM8 API",
    "description": "Move your app forward with the ServiceM8 API\n\n\n\n## Limits and Throttling\nTo ensure continuous quality of service, API usage can be subject to throttling. The throttle will be applied once an API consumer reaches a certain \nthreshold in terms of a maximum number of requests per minute. Most clients will never hit this threshold, but those that do, will get met by a \nHTTP 429 Too Many Requests response code. \n \nThere is a limit of 180 requests per minute, if you reach this you will receive a HTTP 429 with a text body of \"Number of allowed API requests per minute exceeded\".\nThere is a limit of 20000 requests per day, if you reach this you will receive a HTTP 429 with a text body of \"Number of allowed API requests per day exceeded\".\n\nWe encourage all API developers to anticipate this error, and take appropriate measures like e.g. using a cached value from a previous call, or passing on a message to the end user that gets subjected to this behaviour (if any).\n\nLimits are per Addon per account.\n\n\n## Opening Records in ServiceM8\nWhen you need to send a staff member from an external app to a ServiceM8 record in the web app, build the URL using the record UUID on the primary app domain:\n\n* Job: `https://go.servicem8.com/OpenJob/{job_uuid}`\n* Client: `https://go.servicem8.com/OpenClient/{company_uuid}`\n\nClient records are exposed by the Company endpoint in the REST API, so use the Company record `uuid` as `{company_uuid}`. These URLs are web app links, not REST API endpoints, and do not use API authentication. Users who are not signed in are redirected through login and then back to the requested record. The signed-in staff member must have access to the record and the relevant ServiceM8 menu permission.\n",
    "termsOfService": "https://www.servicem8.com/terms-of-service",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.servicem8.com/api_1.0"
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "oauth2": []
    }
  ],
  "paths": {
    "/jobchecklist/{uuid}.json": {
      "get": {
        "tags": [
          "Job Checklists"
        ],
        "operationId": "getJobChecklists",
        "summary": "Retrieve a Job Checklist",
        "description": "\n\t\t\t\n#### OAuth Scope\nThis endpoint requires the following OAuth scope **read_job_checklists**.\n\n\t\t\t",
        "security": [
          {
            "apiKey": []
          },
          {
            "oauth2": [
              "read_job_checklists"
            ]
          }
        ],
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "UUID of the Job Checklist",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Job Checklist record retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JobChecklist"
                },
                "examples": {
                  "success": {
                    "value": {
                      "uuid": "123e4567-f3ff-45ba-92fa-ee9d7199e9ab",
                      "active": 1,
                      "edit_date": "2025-01-01 12:00:00",
                      "job_uuid": "123e4567-6ab5-4d41-ac7c-d718f333ae91",
                      "name": "string",
                      "section_name": "string",
                      "item_type": "string",
                      "sort_order": 0,
                      "completed_timestamp": "2025-01-01 12:00:00",
                      "completed_by_staff_uuid": "123e4567-5d01-47cb-8a13-cd8c912dc16c",
                      "completed_during_checkin_uuid": "123e4567-187f-4f4d-a912-fb637f6c14e7",
                      "reminder_type": "string",
                      "reminder_data": "string",
                      "regarding_object": "string",
                      "regarding_object_uuid": "123e4567-6fef-4c86-917b-c43ce6a2f034",
                      "fulfilled_by_object_name": "string",
                      "fulfilled_by_object_uuid": "123e4567-6e7e-43fb-b747-bd494b4e86bf",
                      "assigned_to_staff_uuids": "123e4567-9dd8-42ed-bf51-96cdf8d4c563",
                      "is_locked": 0,
                      "assigned_timestamp": "2025-01-01 12:00:00",
                      "assigned_by_staff_uuid": "123e4567-db88-43e9-a62c-a9420c99c068"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request - The request is malformed or contains invalid parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "badRequest": {
                    "value": {
                      "errorCode": 1000,
                      "message": "An error occurred completing your request"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized - Authentication credentials are missing or invalid",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuthenticationError"
                },
                "examples": {
                  "unauthorized": {
                    "value": {
                      "errorCode": 401,
                      "message": "Authentication failed. Please check your API key or OAuth token."
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden - You don't have permission to access this resource",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ForbiddenError"
                },
                "examples": {
                  "forbidden": {
                    "value": {
                      "errorCode": 403,
                      "message": "Access forbidden. You don't have permission to access this resource."
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found - The requested record does not exist or has been deleted",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFoundError"
                },
                "examples": {
                  "notFound": {
                    "value": {
                      "errorCode": 404,
                      "message": "Resource not found. The requested record does not exist or has been deleted."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests - You have exceeded the rate limit",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RateLimitError"
                },
                "examples": {
                  "rateLimitMinute": {
                    "value": {
                      "errorCode": 429,
                      "message": "Number of allowed API requests per minute exceeded"
                    }
                  },
                  "rateLimitDay": {
                    "value": {
                      "errorCode": 429,
                      "message": "Number of allowed API requests per day exceeded"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error - An unexpected error occurred on the server",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "serverError": {
                    "value": {
                      "errorCode": 500,
                      "message": "An unexpected error occurred. Please try again later."
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKey": {
        "type": "apiKey",
        "name": "X-Api-Key",
        "in": "header"
      },
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://api.servicem8.com/oauth/authorize",
            "tokenUrl": "https://api.servicem8.com/oauth/access_token",
            "scopes": {
              "staff_locations": "Access to real-time GPS information about staff",
              "staff_activity": "Access to clock on, lunch break and clock off information about staff",
              "publish_sms": "Access to send SMS messages to customers and/or staff on your behalf. Note sending SMS messages will incur account charges.",
              "publish_email": "Access to send Email messages to customers and/or staff on your behalf",
              "vendor": "Access to basic account information",
              "vendor_logo": "Access to account logo",
              "vendor_email": "Access to account holder email address",
              "read_locations": "Read-only access to Location Endpoint",
              "manage_locations": "Full access to Location Endpoint",
              "read_staff": "Read-only access to Staff Endpoint",
              "manage_staff": "Full access to Staff Endpoint",
              "read_customers": "Read-only access to Company Endpoint",
              "manage_customers": "Full access to Company Endpoint",
              "read_customer_contacts": "Read-only access to CompanyContact Endpoint",
              "manage_customer_contacts": "Full access to CompanyContact Endpoint",
              "read_jobs": "Read-only access to Job and Badge endpoints; includes read_badges",
              "manage_jobs": "Full access to Job Endpoint",
              "create_jobs": "Ability to create jobs on behalf of account. Note creating jobs may incur account charges.",
              "read_job_contacts": "Read-only access to JobContact Endpoint",
              "manage_job_contacts": "Full access to JobContact Endpoint",
              "read_job_materials": "Read-only access to JobMaterials Endpoint",
              "manage_job_materials": "Full access to JobMaterials Endpoint",
              "read_job_categories": "Read-only access to Categories Endpoint",
              "manage_job_categories": "Full access to Categories Endpoint",
              "read_job_queues": "Read-only access to Job Queues Endpoint",
              "manage_job_queues": "Full access to Job Queues Endpoint",
              "read_tasks": "Read-only access to Tasks Endpoint",
              "manage_tasks": "Full access to Tasks Endpoint",
              "read_schedule": "Read-only access to JobActivity Endpoint",
              "manage_schedule": "Full access to JobActivity Endpoint",
              "read_inventory": "Read-only access to Materials Endpoint",
              "manage_inventory": "Full access to Materials Endpoint",
              "read_job_notes": "Read-only access to job notes",
              "publish_job_notes": "Ability to add new job notes",
              "read_job_photos": "Read-only access to job photos",
              "publish_job_photos": "Ability to add new job photos",
              "read_attachments": "Read-only access to Attachments Endpoint",
              "manage_attachments": "Full access to Attachments Endpoint",
              "read_inbox": "Read-only access to inbox messages",
              "read_messages": "Read-only access to staff messages",
              "manage_notifications": "Ability to read notifications and mark as read",
              "read_templates": "Read-only access to email, sms and document templates",
              "manage_templates": "Full-access to email, sms and document templates; includes read_templates",
              "read_badges": "Read-only access to job badges; also granted by read_jobs",
              "manage_badges": "Full-access to read/create/modify job badges; includes read_badges",
              "read_assets": "Read-only access to Assets Endpoint",
              "manage_assets": "Full access to Assets Endpoint",
              "read_knowledge_base": "Read-only access to Knowledge Base Endpoint",
              "manage_knowledge_base": "Full access to Knowledge Base Endpoint",
              "publish_diary_items": "Create immutable Add-on Job Diary items",
              "read_email": "Read job email history",
              "read_sms": "Read job SMS history",
              "create_notifications": "Create staff notifications",
              "read_service_templates": "Read access to ServiceTemplates",
              "manage_service_templates": "Full access to manage ServiceTemplates",
              "read_job_admin_activity": "Read-only access to job administration time records"
            }
          }
        }
      }
    },
    "schemas": {
      "AuthenticationError": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "number",
            "format": "int32",
            "example": 401
          },
          "message": {
            "type": "string",
            "example": "Authentication failed. Please check your API key or OAuth token."
          }
        }
      },
      "Error": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "number",
            "format": "int32",
            "example": 1000
          },
          "message": {
            "type": "string",
            "example": "An error occurred completing your request"
          }
        }
      },
      "ForbiddenError": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "number",
            "format": "int32",
            "example": 403
          },
          "message": {
            "type": "string",
            "example": "Access forbidden. You don't have permission to access this resource."
          }
        }
      },
      "JobChecklist": {
        "type": "object",
        "properties": {
          "uuid": {
            "format": "uuid",
            "description": "Unique identifier for this record",
            "example": "123e4567-aaa9-430e-8bd9-db6edd1e45d8",
            "type": "string"
          },
          "active": {
            "enum": [
              0,
              1
            ],
            "type": "integer",
            "default": 1,
            "description": "Record active/deleted flag. Valid values are [0,1]"
          },
          "edit_date": {
            "readOnly": true,
            "example": "2025-01-01 12:00:00",
            "description": "Timestamp at which record was last modified"
          },
          "job_uuid": {
            "format": "uuid",
            "example": "123e4567-90da-4c66-b54a-8a15fc48df46",
            "type": "string",
            "description": "UUID of the job this checklist item belongs to. This links the checklist item to a specific job in the system."
          },
          "name": {
            "type": "string",
            "description": "The name or description of the checklist item. This is displayed to users in the mobile app and web interface.",
            "maxLength": 512
          },
          "section_name": {
            "type": "string",
            "description": "The section or category name under which this checklist item is grouped. This helps organize related checklist items together.",
            "maxLength": 256
          },
          "item_type": {
            "type": "string",
            "description": "The type of checklist item. Valid values are: 'Todo', 'Asset', 'Photo', 'Form', and 'Document'. Defaults to 'Todo' if not specified. This determines the functionality and appearance of the checklist item."
          },
          "sort_order": {
            "type": "integer",
            "description": "A numeric value determining the order in which checklist items appear in the user interface. Lower values appear first. Used to customize the display sequence of items."
          },
          "completed_timestamp": {
            "type": "string",
            "description": "The date and time when the checklist item was marked as completed. Empty or '0000-00-00 00:00:00' indicates the item is not completed.",
            "example": "2025-01-01 12:00:00"
          },
          "completed_by_staff_uuid": {
            "format": "uuid",
            "example": "123e4567-0101-48e5-8256-15c2204ad685",
            "type": "string",
            "description": "UUID of the staff member who completed this checklist item. References a Staff object. Empty if the item is not completed."
          },
          "completed_during_checkin_uuid": {
            "format": "uuid",
            "example": "123e4567-95a4-4bd9-835d-00c283353ca6",
            "type": "string",
            "description": "UUID of the job check-in during which this checklist item was completed. This links the checklist completion to a specific check-in event in the job history."
          },
          "reminder_type": {
            "type": "string",
            "description": "The type of reminder associated with this checklist item. Valid values are: '' (no reminder), 'CHECK_IN', 'NAVIGATE', 'CHECK_OUT', 'ABSOLUTE_DATETIME', or 'RELATIVE_DATETIME'. Determines when the system will remind users about this checklist item."
          },
          "reminder_data": {
            "type": "string",
            "description": "JSON data containing additional information for the reminder. Format depends on the reminder_type. For ABSOLUTE_DATETIME, includes 'absoluteDateTime'. For RELATIVE_DATETIME, includes 'relativeDateTime' with 'baseDate', 'unit', and 'quantity'. Exposed via API as 'reminder_data'.",
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "absoluteDateTime": {
                    "type": "string",
                    "pattern": "^\\d{4}-\\d{2}-\\d{2}\\ \\d{2}:\\d{2}:\\d{2}$"
                  }
                },
                "required": [
                  "absoluteDateTime"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "relativeDateTime": {
                    "type": "object",
                    "properties": {
                      "baseDate": {
                        "type": "string",
                        "enum": [
                          "JOB_CREATE_TIME",
                          "NEXT_BOOKING_TIME"
                        ]
                      },
                      "unit": {
                        "type": "string",
                        "enum": [
                          "DAY",
                          "HOUR",
                          "MINUTE"
                        ]
                      },
                      "quantity": {
                        "type": "integer",
                        "description": "Number of units to add/subtract from base date. Negative quantities mean the reminder occurs before the base date. Reminders scheduled into the past will not occur."
                      }
                    },
                    "required": [
                      "baseDate",
                      "unit",
                      "quantity"
                    ]
                  }
                },
                "required": [
                  "relativeDateTime"
                ],
                "additionalProperties": false
              }
            ]
          },
          "regarding_object": {
            "type": "string",
            "description": "The type of object which this checklist item is related to. For example, for Form checklists, this will be 'Form'."
          },
          "regarding_object_uuid": {
            "format": "uuid",
            "example": "123e4567-0994-49c7-bf73-60c9728297d3",
            "type": "string",
            "description": "The UUID of the object which this checklists item is related to. For example, for Form checklists, this is the UUID of the Form that must be completed to complete the checklist item."
          },
          "fulfilled_by_object_name": {
            "type": "string",
            "description": "The type of object which completes this checklist item. For example, for Form checklists, this will be 'FormResponse'."
          },
          "fulfilled_by_object_uuid": {
            "format": "uuid",
            "example": "123e4567-d36d-4515-a079-9e253733170c",
            "type": "string",
            "description": "The UUID of the object which completes this checklist item. For example, for Form checklists, this references the UUID of a FormResponse record."
          },
          "assigned_to_staff_uuids": {
            "format": "uuid",
            "example": "123e4567-5f26-4aaa-9941-b518f227f95c",
            "type": "array",
            "description": "JSON array of staff UUIDs to whom this checklist item is assigned. Determines which staff members are responsible for completing this checklist item. Currently limited to a maximum of 1 staff member.",
            "items": {
              "type": "string",
              "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
              "description": "Must be the UUID of a Staff record"
            },
            "maxItems": 1
          },
          "is_locked": {
            "type": "integer",
            "description": "If this checklist item is locked (read-only) and cannot be modified. This is set by the system when the checklist item is created from a Task or Network Request. (Read only). Valid values are [0,1]",
            "enum": [
              0,
              1
            ]
          },
          "assigned_timestamp": {
            "type": "string",
            "description": "The timestamp when the checklist item was assigned to the staff member. (Read only)",
            "example": "2025-01-01 12:00:00"
          },
          "assigned_by_staff_uuid": {
            "format": "uuid",
            "example": "123e4567-43b9-4919-9328-b017bfddde22",
            "type": "string",
            "description": "The UUID of the staff member who assigned the checklist item to the staff member. (Read only)"
          }
        }
      },
      "NotFoundError": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "number",
            "format": "int32",
            "example": 404
          },
          "message": {
            "type": "string",
            "example": "Resource not found. The requested record does not exist or has been deleted."
          }
        }
      },
      "RateLimitError": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "number",
            "format": "int32",
            "example": 429
          },
          "message": {
            "type": "string",
            "example": "Number of allowed API requests per minute exceeded"
          }
        }
      }
    }
  },
  "x-speakeasy-retries": {
    "strategy": "backoff",
    "backoff": {
      "initialInterval": 500,
      "maxInterval": 60000,
      "maxElapsedTime": 3600000,
      "exponent": 1.5
    },
    "statusCodes": [
      "5XX",
      "429"
    ],
    "retryConnectionErrors": true
  },
  "tags": [
    {
      "name": "Job Checklists",
      "description": "Operations related to Job Checklists"
    }
  ]
}
```