Retrieve company list

Gets a list of companies associated to your api key.

SecurityApiKeyAuth and CustomAuth
Request
path Parameters
state
required
string

Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating.

Enum: "ca" "il" "wa" "ma" "md" "mi" "wv" "co" "ok" "oh"
query Parameters
entity_state
string

Queryable entity states for company.

Enum: "active" "inactive" "deleted"
header Parameters
x-api-key
required
string

Trace API key header

Example: b123x21wbHlkYXBpa2V5
Authorization
required
string

Company and user credentials authentication

Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5
Responses
200

OK

400

Bad Request

get/{state}/v1/config/companies
Response samples
application/json
{
  • "results": {
    },
  • "warnings": [ ]
}