Skip to content
API Reference
/
Forms

Onboarded API (0.0.1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

https://docs.onboarded.com/_mock/openapi/

https://app.onboarded.com/

Components

Components APIs

Operations

Employees

Employees APIs

Operations

Employers

Employers APIs

Operations

Clients

Clients APIs

Operations

Jobs

Jobs APIs

Operations

Placements

Placements APIs

Operations

Tasks

Tasks APIs

Operations

Task Change Requests

Task Change Requests APIs

Operations

Forms

Forms APIs

Operations

List all forms

Request

Security
bearerAuth
Query
pagenumber>= 1
Default 1
per_pagenumber[ 1 .. 300 ]
Default 20
namestring

Filter forms by name

tagsstring

Filter forms by comma-separated tag names

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/forms?page=1&per_page=20&name=string&tags=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

200

Bodyapplication/json
dataArray of objectsrequired
data[].​idstringrequired
data[].​namestringrequired
data[].​custom_attributesobjectrequired

Custom attribute values

data[].​form_pagesArray of objectsrequired
data[].​form_pages[].​idstringrequired
data[].​form_pages[].​descriptionstring or nullrequired
data[].​form_pages[].​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[].​ruleobject or nullrequired
data[].​form_pages[].​form_fields[].​translationsobject or null

Field translations (optionally expanded)

data[].​tagsArray of objectsrequired
data[].​tags[].​namestringrequired
totalnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "total": 0
}

Get a form by id

Request

Security
bearerAuth
Path
idstringrequired
curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/forms/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

200

Bodyapplication/json
idstringrequired
namestringrequired
custom_attributesobjectrequired

Custom attribute values

form_pagesArray of objectsrequired
form_pages[].​idstringrequired
form_pages[].​descriptionstring or nullrequired
form_pages[].​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[].​ruleobject or nullrequired
form_pages[].​form_fields[].​translationsobject or null

Field translations (optionally expanded)

tagsArray of objectsrequired
tags[].​namestringrequired
Response
application/json
{
  "id": "string",
  "name": "string",
  "custom_attributes": {},
  "form_pages": [
    { … }
  ],
  "tags": [
    { … }
  ]
}

Files

Files APIs

Operations

Themes

Themes APIs

Operations

Custom Properties

Custom Properties APIs

Operations