Sign in
Form Responses

Create a new Form Response

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 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-bb2c-47f8-938d-23422e8b9f8b",
  "staff_uuid": "123e4567-d092-4292-9d9e-234225e1cc4b",
  "regarding_object_uuid": "123e4567-5256-463b-aa11-234222e2849b",
  "timestamp": "2025-09-01 12:00:00",
  "form_by_staff_uuid": "123e4567-7fdd-42aa-8bd5-2342240d7d6b",
  "document_attachment_uuid": "123e4567-5788-4234-bf1c-2342247e411b",
  "asset_uuid": "123e4567-6226-4383-b3c7-23422f03a50b",
  "uuid": "123e4567-b640-40f1-a792-23422370ff4b"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes