Sign in
Forms

Retrieve a Form

OAuth Scope

This endpoint requires the following OAuth scope read_forms.

get/form/{uuid}.json

Path parameters

uuidstring uuid required

UUID of the Form

Response

Form record

namestring

The name of the form. Used to identify the form in the system and displayed to users in the form selector. Must be unique within an account. Maximum length is 255 characters.

document_template_uuidstring uuid

UUID of the document template associated with this form. The template defines the layout and appearance of the form when it's generated as a document. References a document template object in the system.

can_be_used_independentlystring

Boolean flag indicating whether this form can be used independently of a job. When set to true (1), the form can be filled out as a standalone form. When false (0), the form must be associated with a job to be completed.

badge_mandatory_statestring

Controls when badge completion is mandatory for this form. Valid values are: 0 (not mandatory), 1 (mandatory on check-in), 2 (mandatory on check-out). This determines at which stage in the job lifecycle a staff member must complete this form.

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

badge_namestring

Example response

{
  "document_template_uuid": "123e4567-3de1-4f2c-814a-231ef82ec6db",
  "uuid": "123e4567-62ad-4ede-a39b-231ef935bdbb",
  "edit_date": "2025-08-01 12:00:00"
}

Changes