Retrieve employee(s)

Retrieve employee details. If the id path parameter is not provided in the request, the response will contain all the active employees for the license_number provided.

SecurityApiKeyAuth and CustomAuth
Request
path Parameters
id
required
string

id of the employee

Example: a521f55de4394f4f99c282be687e63aa
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
license_number
required
string

Reference (entity_ID) for the license. This is the business license number issued by the state.

Example: license_number=ABC-1234
entity_state
string

Queryable entity states for employee. Inactive will return terminated and deleted employees.

Enum: "active" "inactive" "deleted"
start_date
string

Starting date in ISO 8601 UTC format for the time range of employee's modifications. Only applicable if entity_state query parameter is used.

Example: start_date=2020-09-04
end_date
string

End date in ISO 8601 UTC format for the time range of employee's modifications. Only applicable if entity_state query parameter is used.

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/employees/{id}
Response samples
application/json
{
  • "results": {
    },
  • "warnings": [ ]
}