Get an employer by id

Components
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Components APIs

Operations

Employees
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Employees APIs

Operations

Employers
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Employers APIs

Operations

List all employers

Request

Security

bearerAuth

Query

pagenumber>= 1

Default 1

per_pagenumber[ 1 .. 300 ]

Default 20

custom_attributesstring

Stringified JSON to filter employers by custom attributes. Example: {"location": "Boston"}

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/employers?page=1&per_page=20&custom_attributes=string' \
  -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[].addressobject or null

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

Security

bearerAuth

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

addressobject or null

custom_attributesobject or null

Custom attributes

active_theme_idstring or null

property name*anyadditional property

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",
      "full_address": "string"
    },
    "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

addressobject or null

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",
    "full_address": "string"
  },
  "custom_attributes": {},
  "active_theme_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}