Document Templates

Retrieve a Document Template

Changed on

OAuth Scope

This endpoint requires the following OAuth scope manage_templates.

get/documenttemplate/{uuid}.json

Request

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

Path parameters

uuidstring uuid required

UUID of the Document Template

Response

Document Template record retrieved successfully

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

template_typestring

(Read only)

related_objectstring

(Read only)

namestring

Example response

{
  "uuid": "123e4567-34d8-4f91-be62-23f94abfa16b",
  "edit_date": "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

  • e859f8c27a21Revision changes
    • info

      the security scope manage_templates was added to the endpoint's security scheme oauth2