Employers

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

List all employers

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

custom_attributesstring

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/employers?page=string&per_page=string&custom_attributes=string' \
  -b __session=YOUR_API_KEY_HERE

Responses

Success

Bodyapplication/json

dataArray of objects(Employer)required

data[].idstring(EmployerId)^er_required

Employer Identifier

data[].namestringrequired

data[].einstring or nullrequired

Any of:

string

data[].dba_namestring or nullrequired

Any of:

string

data[].phonestring or nullrequired

Any of:

string

data[].employee_countnumber or nullrequired

Any of:

number

data[].entity_structureEntityStructure (string) or nullrequired

Any of:

Legal entity structure of the employer

string(EntityStructure)

Enum"sole_proprietorship""partnership""llc""corporation""nonprofit""cooperative""professional_corporation"

data[].naics_codestring or nullrequired

Any of:

string

data[].addressAddress (object) or nullrequired

Any of:

An address resource

data[].address.streetstringrequired

data[].address.secondarystring or null

Any of:

string

data[].address.citystringrequired

data[].address.statestringrequired

data[].address.zipstring or null

Any of:

string

data[].address.countrystringrequired

data[].address.full_addressstring or null

Any of:

string

data[].custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

data[].active_theme_idstring or nullrequired

Any of:

string

data[].created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

data[].updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

data[].property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

totalnumberrequired

current_pagenumberrequired

per_pagenumberrequired

total_pagesnumber

Response

application/json

{
  "data": [
    { … }
  ],
  "total": 0,
  "current_page": 0,
  "per_page": 0,
  "total_pages": 0
}

Create a new employer

Request

Security

user_session or form_session or component_session or component_token or api_token

Bodyapplication/jsonrequired

namestringrequired

einstring or null

Any of:

string

dba_namestring or null

Any of:

string

phonestring or null

Any of:

string

employee_countnumber or null

Any of:

number

entity_structureEntityStructure (string) or null

Any of:

Legal entity structure of the employer

string(EntityStructure)

Enum"sole_proprietorship""partnership""llc""corporation""nonprofit""cooperative""professional_corporation"

naics_codestring or null

Any of:

string

addressAddress (object) or null

Any of:

An address resource

custom_attributesobject(CustomAttributes)

Record of custom attribute values keyed by string path.

active_theme_idstring or null

Any of:

string

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/employers \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "name": "string",
    "ein": "string",
    "dba_name": "string",
    "phone": "string",
    "employee_count": 0,
    "entity_structure": "sole_proprietorship",
    "naics_code": "string",
    "address": {
      "street": "123 Main St",
      "secondary": "Suite 100",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94102",
      "country": "US",
      "full_address": "123 Main St, San Francisco, CA 94102"
    },
    "custom_attributes": {
      "property1": null,
      "property2": null
    },
    "active_theme_id": "string",
    "property1": null,
    "property2": null
  }'

Responses

An employer with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base employer schema.

Bodyapplication/json

idstring(EmployerId)^er_required

Employer Identifier

namestringrequired

einstring or nullrequired

Any of:

string

dba_namestring or nullrequired

Any of:

string

phonestring or nullrequired

Any of:

string

employee_countnumber or nullrequired

Any of:

number

entity_structureEntityStructure (string) or nullrequired

Any of:

Legal entity structure of the employer

string(EntityStructure)

Enum"sole_proprietorship""partnership""llc""corporation""nonprofit""cooperative""professional_corporation"

naics_codestring or nullrequired

Any of:

string

addressAddress (object) or nullrequired

Any of:

An address resource

address.streetstringrequired

address.secondarystring or null

Any of:

string

address.citystringrequired

address.statestringrequired

address.zipstring or null

Any of:

string

address.countrystringrequired

address.full_addressstring or null

Any of:

string

custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

active_theme_idstring or nullrequired

Any of:

string

created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

Response

application/json

{
  "id": "er_abc123def456",
  "name": "string",
  "ein": "string",
  "dba_name": "string",
  "phone": "string",
  "employee_count": 0,
  "entity_structure": "sole_proprietorship",
  "naics_code": "string",
  "address": {
    "street": "123 Main St",
    "secondary": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94102",
    "country": "US",
    "full_address": "123 Main St, San Francisco, CA 94102"
  },
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "active_theme_id": "string",
  "created_at": "string",
  "updated_at": "string",
  "property1": null,
  "property2": null
}

Get an employer by ID

Request

Security

user_session or form_session or component_session or component_token or api_token

Path

employer_idstring(EmployerId)^er_required

Employer Identifier

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/employers/{employer_id}' \
  -b __session=YOUR_API_KEY_HERE

Responses

An employer with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base employer schema.

Bodyapplication/json

idstring(EmployerId)^er_required

Employer Identifier

namestringrequired

einstring or nullrequired

Any of:

string

dba_namestring or nullrequired

Any of:

string

phonestring or nullrequired

Any of:

string

employee_countnumber or nullrequired

Any of:

number

entity_structureEntityStructure (string) or nullrequired

Any of:

Legal entity structure of the employer

string(EntityStructure)

Enum"sole_proprietorship""partnership""llc""corporation""nonprofit""cooperative""professional_corporation"

naics_codestring or nullrequired

Any of:

string

addressAddress (object) or nullrequired

Any of:

An address resource

address.streetstringrequired

address.secondarystring or null

Any of:

string

address.citystringrequired

address.statestringrequired

address.zipstring or null

Any of:

string

address.countrystringrequired

address.full_addressstring or null

Any of:

string

custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

active_theme_idstring or nullrequired

Any of:

string

created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

Response

application/json

{
  "id": "er_abc123def456",
  "name": "string",
  "ein": "string",
  "dba_name": "string",
  "phone": "string",
  "employee_count": 0,
  "entity_structure": "sole_proprietorship",
  "naics_code": "string",
  "address": {
    "street": "123 Main St",
    "secondary": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94102",
    "country": "US",
    "full_address": "123 Main St, San Francisco, CA 94102"
  },
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "active_theme_id": "string",
  "created_at": "string",
  "updated_at": "string",
  "property1": null,
  "property2": null
}

Update an employer

Request

Security

user_session or form_session or component_session or component_token or api_token

Path

employer_idstring(EmployerId)^er_required

Employer Identifier

Bodyapplication/jsonrequired

namestring

einstring or null

Any of:

string

dba_namestring or null

Any of:

string

phonestring or null

Any of:

string

employee_countnumber or null

Any of:

number

entity_structureEntityStructure (string) or null

Any of:

Legal entity structure of the employer

string(EntityStructure)

Enum"sole_proprietorship""partnership""llc""corporation""nonprofit""cooperative""professional_corporation"

naics_codestring or null

Any of:

string

addressAddress (object) or null

Any of:

An address resource

custom_attributesobject(CustomAttributes)

Record of custom attribute values keyed by string path.

active_theme_idstring or null

Any of:

string

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/employers/{employer_id}' \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "name": "string",
    "ein": "string",
    "dba_name": "string",
    "phone": "string",
    "employee_count": 0,
    "entity_structure": "sole_proprietorship",
    "naics_code": "string",
    "address": {
      "street": "123 Main St",
      "secondary": "Suite 100",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94102",
      "country": "US",
      "full_address": "123 Main St, San Francisco, CA 94102"
    },
    "custom_attributes": {
      "property1": null,
      "property2": null
    },
    "active_theme_id": "string",
    "property1": null,
    "property2": null
  }'

Responses

An employer with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base employer schema.

Bodyapplication/json

idstring(EmployerId)^er_required

Employer Identifier

namestringrequired

einstring or nullrequired

Any of:

string

dba_namestring or nullrequired

Any of:

string

phonestring or nullrequired

Any of:

string

employee_countnumber or nullrequired

Any of:

number

entity_structureEntityStructure (string) or nullrequired

Any of:

Legal entity structure of the employer

string(EntityStructure)

Enum"sole_proprietorship""partnership""llc""corporation""nonprofit""cooperative""professional_corporation"

naics_codestring or nullrequired

Any of:

string

addressAddress (object) or nullrequired

Any of:

An address resource

address.streetstringrequired

address.secondarystring or null

Any of:

string

address.citystringrequired

address.statestringrequired

address.zipstring or null

Any of:

string

address.countrystringrequired

address.full_addressstring or null

Any of:

string

custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

active_theme_idstring or nullrequired

Any of:

string

created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

Response

application/json

{
  "id": "er_abc123def456",
  "name": "string",
  "ein": "string",
  "dba_name": "string",
  "phone": "string",
  "employee_count": 0,
  "entity_structure": "sole_proprietorship",
  "naics_code": "string",
  "address": {
    "street": "123 Main St",
    "secondary": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94102",
    "country": "US",
    "full_address": "123 Main St, San Francisco, CA 94102"
  },
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "active_theme_id": "string",
  "created_at": "string",
  "updated_at": "string",
  "property1": null,
  "property2": null
}

Delete an employer

Request

Security

user_session or form_session or component_session or component_token or api_token

Path

employer_idstring(EmployerId)^er_required

Employer Identifier

curl -i -X DELETE \
  'https://docs.onboarded.com/_mock/openapi/api/v1/employers/{employer_id}' \
  -b __session=YOUR_API_KEY_HERE

Responses

An employer with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base employer schema.

Bodyapplication/json

idstring(EmployerId)^er_required

Employer Identifier

namestringrequired

einstring or nullrequired

Any of:

string

dba_namestring or nullrequired

Any of:

string

phonestring or nullrequired

Any of:

string

employee_countnumber or nullrequired

Any of:

number

entity_structureEntityStructure (string) or nullrequired

Any of:

Legal entity structure of the employer

string(EntityStructure)

Enum"sole_proprietorship""partnership""llc""corporation""nonprofit""cooperative""professional_corporation"

naics_codestring or nullrequired

Any of:

string

addressAddress (object) or nullrequired

Any of:

An address resource

address.streetstringrequired

address.secondarystring or null

Any of:

string

address.citystringrequired

address.statestringrequired

address.zipstring or null

Any of:

string

address.countrystringrequired

address.full_addressstring or null

Any of:

string

custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

active_theme_idstring or nullrequired

Any of:

string

created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

Response

application/json

{
  "id": "er_abc123def456",
  "name": "string",
  "ein": "string",
  "dba_name": "string",
  "phone": "string",
  "employee_count": 0,
  "entity_structure": "sole_proprietorship",
  "naics_code": "string",
  "address": {
    "street": "123 Main St",
    "secondary": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94102",
    "country": "US",
    "full_address": "123 Main St, San Francisco, CA 94102"
  },
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "active_theme_id": "string",
  "created_at": "string",
  "updated_at": "string",
  "property1": null,
  "property2": null
}

Files

API for accessing uploaded files

Operations

Forms

API for accessing forms

Operations

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

Magic Links

API for creating magic links for user authentication

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

Onboarded Public API (0.0.1)
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

Clients

Components

Connected Organizations

Employees

Employers

List all employers

Request

Responses

Was this helpful?

Create a new employer

Request

Responses

Was this helpful?

Get an employer by ID

Request

Responses

Was this helpful?

Update an employer

Request

Responses

Was this helpful?

Delete an employer

Request

Responses

Was this helpful?

Files

Forms

Tasks

Jobs

Placements

Themes

Custom Properties

Magic Links

Subtasks

Task Change Requests

Users

Webhooks

Onboarded Public API (0.0.1)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Clients

Components

Connected Organizations

Employees

Employers

List all employers

Request

Responses

Was this helpful?

Create a new employer

RequestExpand all

Responses

Was this helpful?

Get an employer by ID

Request

Responses

Was this helpful?

Update an employer

RequestExpand all

Responses

Was this helpful?

Delete an employer

Request

Responses

Was this helpful?

Files

Forms

Tasks

Jobs

Placements

Themes

Custom Properties

Magic Links

Subtasks

Task Change Requests

Users

Webhooks

Onboarded Public API (0.0.1)
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

Request

Request