Sign in
latestSwagger 2.02026-08-0982147352.7 KB

be66ed178abe

Company

companies

Returns the list of companies you have access to.<p>Scopes: export_company_info</p>

get/v{version}/companies

Path parameters

versionstring required

Query parameters

start_idstring

The id to start fetching from. Optional.

namestring

Limits the companies returned to companies that contain (partial match) the provided name, case insensitive, if provided. Optional.

limitinteger

Limits the number of records returned. Optional. The default is 50.

Response

Success

next_idstring

The id of the object next up after this set.

errorstring

Contains any error messages, if applicable.

Example response

{
  "data": [
    {
      "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"
    }
  ]
}