Form Responses

Retrieve a Form Response

Changed on

OAuth Scope

This endpoint requires the following OAuth scope read_forms.

get/formresponse/{uuid}.json

Request

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

Path parameters

uuidstring uuid required

UUID of the Form Response

Response

Form Response record retrieved successfully

form_uuidstring uuid

UUID of the form used to generate this form response. Links to a specific form in the system that defines the fields to be gathered.

staff_uuidstring uuid

UUID of the staff member who completed this FormResponse.

regarding_objectstring

The object type that this form response is associated with. Common values include 'job', 'asset', or 'company'. Works in conjunction with regarding_object_uuid to link this form response to a specific record in the system.

regarding_object_uuidstring uuid

UUID of the specific record this form response is linked to. For example, if regarding_object is 'job', this will be the UUID of the specific job. This creates a relationship between the form response and the object it refers to.

field_datastring

JSON array of form answers captured at submission time.

timestampstring

Date and time when the form was submitted/completed. Used for sorting and displaying form responses chronologically. Format is YYYY-MM-DD HH:MM:SS in UTC timezone.

form_by_staff_uuidstring uuid

UUID of the staff member who completed or submitted this form. Identifies which user filled out the form. Used for tracking form submission history and staff accountability.

document_attachment_uuidstring uuid

UUID of the document attachment generated from this form response. When a form is completed, it can generate a PDF document which is stored as an attachment. This field links to that generated document attachment.

asset_uuidstring uuid

UUID of the Asset this form response is related to. Used when the FormResponsepertains to a specific asset, such as equipment inspections, maintenance checklists, or asset condition reports.

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

{
  "form_uuid": "123e4567-8f59-4273-9bb2-23f94e3071eb",
  "staff_uuid": "123e4567-068f-433c-a2e6-23f94e815bdb",
  "regarding_object_uuid": "123e4567-41ee-4ea3-8ca2-23f94fe918eb",
  "timestamp": "2026-03-01 12:00:00",
  "form_by_staff_uuid": "123e4567-0230-4fe1-83c9-23f94429362b",
  "document_attachment_uuid": "123e4567-ff79-499a-8ef4-23f94a981a6b",
  "asset_uuid": "123e4567-fc2c-4a3d-a278-23f942d7f62b",
  "uuid": "123e4567-faa3-4649-8ea5-23f94011885b",
  "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

  • d847d5089d6dRevision changes
    • info

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