Form Responses

Create a new Form Response

Changed on

OAuth Scope

This endpoint requires the following OAuth scope manage_forms.

Record UUID

UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the x-record-uuid response header.

post/formresponse.json

Request

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

Request body

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

Example request

{
  "form_uuid": "123e4567-d318-43fc-97b9-23f94923e6eb",
  "staff_uuid": "123e4567-a1d2-4aa7-89a9-23f94f550c2b",
  "regarding_object_uuid": "123e4567-c625-40d3-8f48-23f94acf41bb",
  "timestamp": "2026-03-01 12:00:00",
  "form_by_staff_uuid": "123e4567-d3c9-4778-8bfa-23f94ad8ecab",
  "document_attachment_uuid": "123e4567-47b9-4310-8001-23f9437ae7bb",
  "asset_uuid": "123e4567-1af8-418f-b168-23f94802b51b",
  "uuid": "123e4567-0582-4709-b0f3-23f9436261cb"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes