SAsalussafety
Form Instances

Get Digital Form

Get a Form Instance, including its contents

This endpoint is different from Get Raw Digital Forms in Bulk in a couple ways:

  • It returns the contents of a single form instance.
  • It returns the contents of the form instance when it was submitted, even if the form template has changed. If fields were added to the form template, they will not be included.
  • Fields that refer to another object (Asset, Document, Site or User) are a link to the API endpoint for that object
  • Attachments are a link to download that image.
  • Tables are included.
get/v1/form-instance/{form_instance_id}/

Request

  • Base URL
    https://developer.beta.salussafety.io
  • URL
    https://developer.beta.salussafety.io/v1/form-instance/{form_instance_id}/
  • Auth
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: https://guardian.beta.salussafety.io/token
    • or OAuth 2
      Authorization code: https://guardian.beta.salussafety.io/authorize
      Token URL: https://guardian.beta.salussafety.io/token

Path parameters

form_instance_idinteger required

Response

Successful Response

errorboolean

A boolean error indicator.

messagestring nullable

Optional message.

Example response

{
  "data": {
    "id": 123,
    "formId": 234,
    "companyId": 45,
    "fields": {
      "attachment_1750273781805998": {
        "name": "Site Photo",
        "value": "https://developer.beta.salussafety.io/v1/form-instance/76/images/attachment_1750273781805998/"
      },
      "decimal_17502731666394148": {
        "name": "Hours Worked",
        "value": 8.5
      },
      "site_17502732474758524": {
        "name": "Work Site",
        "value": "https://developer.beta.salussafety.io/v1/project/123/"
      },
      "table_17502732900583641": {
        "name": "Issue Checklist",
        "value": [
          [
            {
              "name": "Issue Type",
              "value": "Fire escape obstructed"
            },
            {
              "name": "Observed?",
              "value": "No"
            }
          ],
          [
            {
              "name": "Issue Type",
              "value": "Missing hard hats"
            },
            {
              "name": "Observed?",
              "value": "Yes"
            }
          ]
        ]
      },
      "text_17502731460635039": {
        "name": "Work Order",
        "value": "abc-123"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.