Skip to content
API Reference
/
/
Get an employee onboardin...

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

List all employees

Request

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

Stringified JSON to filter employees by custom attributes. Example: {"title": "CEO"}

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

Responses

200

Bodyapplication/json
dataArray of objectsrequired
data[].​idstringrequired
data[].​first_namestringrequired
data[].​middle_namestring
data[].​last_namestringrequired
data[].​emailstring or null
data[].​phonestring or null
data[].​date_of_birthstring or null
data[].​social_security_numberstring or null
data[].​has_middle_nameboolean or null
data[].​addressobject or null
data[].​custom_attributesobjectrequired

Custom attribute values

data[].​created_atstring(date-time)required
data[].​updated_atstring(date-time)required
totalnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "total": 0
}

Create an employee

Request

Security
bearerAuth
Bodyapplication/json

Body

first_namestringrequired
middle_namestring
last_namestringrequired
emailstring or null
phonestring or null
date_of_birthstring or null
social_security_numberstring or null
has_middle_nameboolean or null
addressobject or null
custom_attributesobject or null

Custom attributes

property name*anyadditional property
curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/employees \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "first_name": "string",
    "middle_name": "string",
    "last_name": "string",
    "email": "string",
    "phone": "string",
    "date_of_birth": "string",
    "social_security_number": "string",
    "has_middle_name": true,
    "address": {
      "street": "string",
      "secondary": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "str",
      "full_address": "string"
    },
    "custom_attributes": {}
  }'

Responses

201

Bodyapplication/json
idstringrequired
first_namestringrequired
middle_namestring
last_namestringrequired
emailstring or null
phonestring or null
date_of_birthstring or null
social_security_numberstring or null
has_middle_nameboolean or null
addressobject or null
custom_attributesobjectrequired

Custom attribute values

created_atstring(date-time)required
updated_atstring(date-time)required
Response
application/json
{
  "id": "string",
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "email": "string",
  "phone": "string",
  "date_of_birth": "string",
  "social_security_number": "string",
  "has_middle_name": true,
  "address": {
    "street": "string",
    "secondary": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "str",
    "full_address": "string"
  },
  "custom_attributes": {},
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Get an employee by id

Request

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

Responses

200

Bodyapplication/json
idstringrequired
first_namestringrequired
middle_namestring
last_namestringrequired
emailstring or null
phonestring or null
date_of_birthstring or null
social_security_numberstring or null
has_middle_nameboolean or null
addressobject or null
custom_attributesobjectrequired

Custom attribute values

created_atstring(date-time)required
updated_atstring(date-time)required
Response
application/json
{
  "id": "string",
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "email": "string",
  "phone": "string",
  "date_of_birth": "string",
  "social_security_number": "string",
  "has_middle_name": true,
  "address": {
    "street": "string",
    "secondary": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "str",
    "full_address": "string"
  },
  "custom_attributes": {},
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Update an employee

Request

Security
bearerAuth
Path
idstringrequired
Bodyapplication/json

Body

first_namestring
middle_namestring
last_namestring
emailstring or null
phonestring or null
date_of_birthstring or null

Employee's date of birth in ISO-8601 format (YYYY-MM-DD).

social_security_numberstring or null

Employee's SSN in the format of xxx-xx-xxxx.

has_middle_nameboolean or null
addressobject or null
custom_attributesobject or null

Custom attributes

property name*anyadditional property
curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/employees/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "first_name": "string",
    "middle_name": "string",
    "last_name": "string",
    "email": "string",
    "phone": "string",
    "date_of_birth": "string",
    "social_security_number": "string",
    "has_middle_name": true,
    "address": {
      "street": "string",
      "secondary": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "str",
      "full_address": "string"
    },
    "custom_attributes": {}
  }'

Responses

200

Bodyapplication/json
idstringrequired
first_namestringrequired
middle_namestring
last_namestringrequired
emailstring or null
phonestring or null
date_of_birthstring or null
social_security_numberstring or null
has_middle_nameboolean or null
addressobject or null
custom_attributesobjectrequired

Custom attribute values

created_atstring(date-time)required
updated_atstring(date-time)required
Response
application/json
{
  "id": "string",
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "email": "string",
  "phone": "string",
  "date_of_birth": "string",
  "social_security_number": "string",
  "has_middle_name": true,
  "address": {
    "street": "string",
    "secondary": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "str",
    "full_address": "string"
  },
  "custom_attributes": {},
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Delete an employee by id

Request

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

Responses

200

Bodyapplication/json
idstringrequired
first_namestringrequired
middle_namestring
last_namestringrequired
emailstring or null
phonestring or null
date_of_birthstring or null
social_security_numberstring or null
has_middle_nameboolean or null
addressobject or null
custom_attributesobjectrequired

Custom attribute values

created_atstring(date-time)required
updated_atstring(date-time)required
Response
application/json
{
  "id": "string",
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "email": "string",
  "phone": "string",
  "date_of_birth": "string",
  "social_security_number": "string",
  "has_middle_name": true,
  "address": {
    "street": "string",
    "secondary": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "str",
    "full_address": "string"
  },
  "custom_attributes": {},
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Get an employee onboarding url

Request

Security
bearerAuth
Path
idstringrequired
Query
assignee_typestring
Enum"employee""employer"
task_idsstring

Comma separated list of task ids

localestring

Locale code (e.g. en, es, fr). If not provided, the language will be selected automatically based on candidate browser language setting and form language availability.

Enum"af""ak""sq""am""ar""hy""as""ay""az""bm"
redirect_tostring(uri)

Redirect to url to send the user after onboarding is complete

active_theme_idstring

Custom theme for the onboarding form

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/employees/{id}/onboarding?assignee_type=employee&task_ids=string&locale=af&redirect_to=http%3A%2F%2Fexample.com&active_theme_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

200

Bodyapplication/json
urlstringrequired
Response
application/json
{
  "url": "string"
}

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

Files

Files APIs

Operations

Themes

Themes APIs

Operations

Custom Properties

Custom Properties APIs

Operations