Get an employer by ID

Request

Security

form_session or user_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}' \
  -H 'Authorization: Bearer <YOUR_Onboarded form session token_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 null

Any of:

string

dba_namestring or nullrequired

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)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

{
  "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
}