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

Onboarded Public API (0.0.1)

Public API for Customers, Partners, and Integrations

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs.onboarded.com/_mock/openapi
Onboarded Production Server
https://app.onboarded.com

Clients

API for managing clients

Operations

Components

API for creating embeddable component URLs

Operations

Connected Organizations

API for managing connected organizations and their configuration

Operations

Employees

API for managing employees

Operations

Employers

API for managing employers

Operations

Files

API for accessing uploaded files

Operations

Forms

API for accessing forms

Operations

List all forms

Request

Security
user_session or form_session or component_session or component_token or api_token
Query
pagestring(between(1, 1000))

a number between 1 and 1000

per_pagestring(between(1, 100))

a number between 1 and 100

namestring
tagsstring
curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/forms?page=string&per_page=string&name=string&tags=string' \
  -b __session=YOUR_API_KEY_HERE

Responses

Success

Bodyapplication/json
dataArray of objects(Form)required
data[].​idstring(FormId)required

Form Identifier (lineage uid)

data[].​namestringrequired

The name of the form

data[].​custom_attributesobjectrequired
data[].​tagsArray of objectsrequired
data[].​tags[].​namestringrequired
data[].​form_pagesArray of objectsrequired
data[].​form_pages[].​idstringrequired
data[].​form_pages[].​descriptionstring or nullrequired
Any of:
string
data[].​form_pages[].​assignee_typestringrequired
Enum"employee""employer""system"
data[].​form_pages[].​form_sectionobject or nullrequired
Any of:
data[].​form_pages[].​form_section.​idstringrequired
data[].​form_pages[].​form_section.​positionnumberrequired
data[].​form_pages[].​form_section.​assignee_typestringrequired
Enum"employee""employer""system"
data[].​form_pages[].​form_fieldsArray of objectsrequired
data[].​form_pages[].​form_fields[].​idstringrequired
data[].​form_pages[].​form_fields[].​typestringrequired
data[].​form_pages[].​form_fields[].​pathstringrequired
data[].​form_pages[].​form_fields[].​ruleany(unknown)required
data[].​form_pages[].​form_fields[].​requiredbooleanrequired
data[].​form_pages[].​form_fields[].​translationsobject
totalnumberrequired
current_pagenumberrequired
per_pagenumberrequired
total_pagesnumber
Response
application/json
{
  "data": [
    { … }
  ],
  "total": 0,
  "current_page": 0,
  "per_page": 0,
  "total_pages": 0
}

Get a form by ID

Request

Security
user_session or form_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}' \
  -b __session=YOUR_API_KEY_HERE

Responses

Form

Bodyapplication/json
idstring(FormId)required

Form Identifier (lineage uid)

namestringrequired

The name of the form

custom_attributesobjectrequired
tagsArray of objectsrequired
tags[].​namestringrequired
form_pagesArray of objectsrequired
form_pages[].​idstringrequired
form_pages[].​descriptionstring or nullrequired
Any of:
string
form_pages[].​assignee_typestringrequired
Enum"employee""employer""system"
form_pages[].​form_sectionobject or nullrequired
Any of:
form_pages[].​form_section.​idstringrequired
form_pages[].​form_section.​positionnumberrequired
form_pages[].​form_section.​assignee_typestringrequired
Enum"employee""employer""system"
form_pages[].​form_fieldsArray of objectsrequired
form_pages[].​form_fields[].​idstringrequired
form_pages[].​form_fields[].​typestringrequired
form_pages[].​form_fields[].​pathstringrequired
form_pages[].​form_fields[].​ruleany(unknown)required
form_pages[].​form_fields[].​requiredbooleanrequired
form_pages[].​form_fields[].​translationsobject
Response
application/json
{
  "id": "tlin_abc123def456",
  "name": "string",
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "tags": [
    { … }
  ],
  "form_pages": [
    { … }
  ]
}

Tasks

API for managing tasks

Operations

Jobs

API for managing jobs

Operations

Placements

API for managing placements

Operations

Themes

API for managing themes

Operations

Custom Properties

API for managing custom properties

Operations

Subtasks

Subtask management and file upload API

Operations

Task Change Requests

API for requesting changes to completed tasks

Operations

Users

API for managing users

Operations

Webhooks

API for managing webhooks

Operations