Company

company

Returns a company.<p>Scopes: export_company_info</p>

get/v{version}/companies/{id}

Request

Base URL
https://api-docs.ease.com (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/ease/apis/version-2/docs/v:version/companies/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

The id of the company.

versionstring required

Response

idstring required

The id of the company.

namestring required

The name of the company.

type'Application' | 'Broker' | 'Client' | 'Partner' | 'Ease' required

The type of the company.

einstring

The EIN of the company.

sicstring

The SIC of the company.

naturestring

The Nature of Business of the company.

established_datestring

The Established Date of the company.

entity_typestring

The Entity Type of the company.

websitestring

The Website of the company.

is_open_enrollmentboolean

Is the company in Open Enrollment?

open_enrollment_start_datestring

Open Enrollment start date.

open_enrollment_end_datestring

Open Enrollment end date.

total_employees_countinteger

The total count of employees.

active_employees_countinteger

The count of active employees.

codesobject

A key value store of custom codes for this company.

last_modified_datestring required

create_datestring required

status'Active' | 'Inactive' | 'Demo' | 'Migrating'

The status of the company.

Example response

{
  "established_date": "yyyy-MM-dd",
  "open_enrollment_start_date": "yyyy-MM-dd",
  "open_enrollment_end_date": "yyyy-MM-dd",
  "last_modified_date": "yyyy-MM-dd",
  "create_date": "yyyy-MM-dd"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.