Skip to content
API Reference
/
/
Get a form by ID

Get a form by ID

Request

Security
form_session or user_session or component_session or component_token or api_token
Path
form_idstring(FormId)required

Form Identifier (lineage uid)

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/forms/{form_id}' \
  -H 'Authorization: Bearer <YOUR_Onboarded form session token_HERE>'

Responses

Form

Bodyapplication/json
idstring(FormId)required

Form Identifier (lineage uid)

namestringrequired

The name of the form

task_reuse_criteriaArray of stringsrequired

Criteria that determine when a new task is created vs reusing an existing one. Values include "employer", "client", "job", or a placement custom attribute path (e.g. "placement.custom_attributes.location").

custom_attributesobjectrequired
tagsArray of objectsrequired
form_pagesArray of objectsrequired
Response
{
  "id": "tlin_abc123def456",
  "name": "string",
  "task_reuse_criteria": [
    "employer",
    "client"
  ],
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "tags": [
    { … }
  ],
  "form_pages": [
    { … }
  ]
}