API Reference
/
Employers

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

List all employers

Request

Query
pagenumber>= 1
Default 1
per_pagenumber[ 1 .. 300 ]
Default 20
curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/employers?page=1&per_page=20' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

200

Bodyapplication/json
dataArray of objectsrequired
data[].​idstringrequired
data[].​namestringrequired
data[].​einstring or null
data[].​dba_namestring or null
data[].​phonestring or null
data[].​employee_countnumber or null
data[].​entity_structurestring or null
Enum"sole_proprietorship""partnership""llc""corporation""nonprofit""cooperative""professional_corporation"
data[].​naics_codestring or null
data[].​addressobjectrequired
data[].​address.​streetstringrequired
data[].​address.​secondarystring or null
data[].​address.​citystringrequired
data[].​address.​statestringrequired
data[].​address.​zipstringrequired
data[].​address.​countrystring[ 2 .. 3 ] charactersrequired

3 letter country code

data[].​custom_attributesobjectrequired

Custom attribute values

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

Create an employer

Request

Bodyapplication/json

Body

namestringrequired
einstring or null
dba_namestring or null
phonestring or null
employee_countnumber or null
entity_structurestring or null
Enum"sole_proprietorship""partnership""llc""corporation""nonprofit""cooperative""professional_corporation"
naics_codestring or null
addressobjectrequired
address.​streetstringrequired
address.​secondarystring or null
address.​citystringrequired
address.​statestringrequired
address.​zipstringrequired
address.​countrystring[ 2 .. 3 ] charactersrequired

3 letter country code

custom_attributesobject or null

Custom attributes

active_theme_idstring or null
curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/employers \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "ein": "string",
    "dba_name": "string",
    "phone": "string",
    "employee_count": 0,
    "entity_structure": "sole_proprietorship",
    "naics_code": "string",
    "address": {
      "street": "string",
      "secondary": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "str"
    },
    "custom_attributes": {},
    "active_theme_id": "string"
  }'

Responses

201

Bodyapplication/json
idstringrequired
namestringrequired
einstring or null
dba_namestring or null
phonestring or null
employee_countnumber or null
entity_structurestring or null
Enum"sole_proprietorship""partnership""llc""corporation""nonprofit""cooperative""professional_corporation"
naics_codestring or null
addressobjectrequired
address.​streetstringrequired
address.​secondarystring or null
address.​citystringrequired
address.​statestringrequired
address.​zipstringrequired
address.​countrystring[ 2 .. 3 ] charactersrequired

3 letter country code

custom_attributesobjectrequired

Custom attribute values

active_theme_idstring or null
created_atstring(date-time)required
updated_atstring(date-time)required
Response
application/json
{
  "id": "string",
  "name": "string",
  "ein": "string",
  "dba_name": "string",
  "phone": "string",
  "employee_count": 0,
  "entity_structure": "sole_proprietorship",
  "naics_code": "string",
  "address": {
    "street": "string",
    "secondary": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "str"
  },
  "custom_attributes": {},
  "active_theme_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Get an employer by id

Request

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

Responses

200

Bodyapplication/json
idstringrequired
namestringrequired
einstring or null
dba_namestring or null
phonestring or null
employee_countnumber or null
entity_structurestring or null
Enum"sole_proprietorship""partnership""llc""corporation""nonprofit""cooperative""professional_corporation"
naics_codestring or null
addressobjectrequired
address.​streetstringrequired
address.​secondarystring or null
address.​citystringrequired
address.​statestringrequired
address.​zipstringrequired
address.​countrystring[ 2 .. 3 ] charactersrequired

3 letter country code

custom_attributesobjectrequired

Custom attribute values

active_theme_idstring or null
created_atstring(date-time)required
updated_atstring(date-time)required
Response
application/json
{
  "id": "string",
  "name": "string",
  "ein": "string",
  "dba_name": "string",
  "phone": "string",
  "employee_count": 0,
  "entity_structure": "sole_proprietorship",
  "naics_code": "string",
  "address": {
    "street": "string",
    "secondary": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "str"
  },
  "custom_attributes": {},
  "active_theme_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Update an employer

Request

Path
idstringrequired
Bodyapplication/json

Body

namestring
einstring or null
dba_namestring or null
phonestring or null
employee_countnumber or null
entity_structurestring or null
Enum"sole_proprietorship""partnership""llc""corporation""nonprofit""cooperative""professional_corporation"
naics_codestring or null
addressobject
custom_attributesobject or null

Custom attributes

active_theme_idstring or null
curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/employers/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "ein": "string",
    "dba_name": "string",
    "phone": "string",
    "employee_count": 0,
    "entity_structure": "sole_proprietorship",
    "naics_code": "string",
    "address": {
      "street": "string",
      "secondary": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "str"
    },
    "custom_attributes": {},
    "active_theme_id": "string"
  }'

Responses

200

Bodyapplication/json
idstringrequired
namestringrequired
einstring or null
dba_namestring or null
phonestring or null
employee_countnumber or null
entity_structurestring or null
Enum"sole_proprietorship""partnership""llc""corporation""nonprofit""cooperative""professional_corporation"
naics_codestring or null
addressobjectrequired
address.​streetstringrequired
address.​secondarystring or null
address.​citystringrequired
address.​statestringrequired
address.​zipstringrequired
address.​countrystring[ 2 .. 3 ] charactersrequired

3 letter country code

custom_attributesobjectrequired

Custom attribute values

active_theme_idstring or null
created_atstring(date-time)required
updated_atstring(date-time)required
Response
application/json
{
  "id": "string",
  "name": "string",
  "ein": "string",
  "dba_name": "string",
  "phone": "string",
  "employee_count": 0,
  "entity_structure": "sole_proprietorship",
  "naics_code": "string",
  "address": {
    "street": "string",
    "secondary": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "str"
  },
  "custom_attributes": {},
  "active_theme_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

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