Employee

Create Employee

Create an employee associated with the license_number provided.

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" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"

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

Request Body schema: application/json

required

object

license_number

required

string

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

required

object

The name of the employee.

first_name	string first name of the employee.
last_name	string last name of the employee.

email_address

required

string

The employee's email address.

phone_number

required

string

The phone number of the employee.

required

object

The type of employment (e.g. full-time, temporary, gig, etc.). List of available types can be obtained via the /employee_types endpoint).

id	string Reference (entity_ID) for the type of employment (e.g. full-time, temporary, gig, etc.). List of available types can be obtained via the /config/employees/types endpoint).

required

Array of objects

The list of facilities the employee is authorized to work in.

Array

string

Array of objects

A list of occupational licenses held by the employee.

Array

type	string The type of license the employee holds.
number	string The number of the license held by the employee.
issuing_state	string issuing state of the license, Lower case ANSI standard INCITS 38:2009 USPS codes of the US state

Array of objects

The list of credentials the employee has for the track & trace system(s) (NOTE: not used in some states).
Required if this employee will be using track & trace system(s).

Array

username	string The username of the employee used for the track & trace system.
password	string The password of the employee used for track & track system.
software_name	string The descriptive name of the track & trace software (e.g. metrc, biotrack, leafdata)
state	string The state the license was issued from.
api_key	string The api key the employee uses for the track and trace system from that state.
other	string Additional field for license information.

Array of objects

The list of permission groups the employee has been assigned. Required if this employee will be using track & trace system.

Array

id	string The id of the permission_group

birthday

required

string

The employees birthday in ISO 8601 UTC format.

hire_date

required

string

The date the employee was hired in ISO 8601 UTC format.

Responses

200

Response Schema: application/json

object

type

string

Value: "object"

object

string

Reference (entity_ID) for the employee.

object

The name of the employee.

first_name	string first name of the employee.
last_name	string last name of the employee.

email_address

string

The employee's email address.

phone_number

string

The phone number of the employee.

object

The type of employment (e.g. full-time, temporary, gig, etc.). List of available types can be obtained via the /config/employees/types endpoint).

id	string Reference (entity_ID) for the type of employment (e.g. full-time, temporary, gig, etc.)
name	string The display name of the employment type.

object

id	string Reference (entity_ID) for the company.
name	string Company name of the license holder.

Array of objects

The list of facilities the employee is authorized to work in.

Array

id	string
name	string
	object

Array of objects

A list of occupational licenses held by the employee.

Array

type	string The type of license the employee holds.
number	string The number of the license held by the employee.
issuing_state	string issuing state of the license, Lower case ANSI standard INCITS 38:2009 USPS codes of the US state

Array of objects

The list of credentials the employee has for the track & trace system(s) (NOTE: not used in some states).
Required if this employee will be using track & trace system(s).

Array

username	string The username of the employee used for the track & trace system.
password	string The password of the employee used for track & track system.
software_name	string The descriptive name of the track & trace software (e.g. metrc, biotrack, leafdata)
state	string The state the license was issued from.
api_key	string The api key the employee uses for the track and trace system from that state.
other	string Additional field for license information.

Array of objects

The list of permission groups the employee has been assigned.

Array

id	string The id of the permission_group
name	string The display name of the permissions_group

birthday

string

The employees birthday in ISO 8601 UTC format.

hire_date

string

The date the employee was hired in ISO 8601 UTC format.

termination_date

string or null

The date the employee's employment was terminated in ISO 8601 UTC format.

Array of objects

A list of state changes made to the entity. Entity states for employees [active, inactive, deleted]

Array

state	string state of the entity.
date	string timestamp when the state was recorded ISO 8601 UTC format.
reason	string additional information for the 'state' change.
actioned_by	string username of the person who updated the state of the entity (if applicable).

Array of objects

Array

type	string
detail	string

400

Bad Request

post/{state}/v1/config/employees

Request samples

Payload

application/json

{"license": {"license_number": "KMPL20200818"
},
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567",
"type": {"id": "5"
},
"facilities": [{"id": "12345"
}
],
"credentials": [{"username": "jdoe@kmpl.com",
"password": "mysecurepassword",
"software_name": "metrc",
"state": "ca",
"api_key": "1234567889asfasdfafaasfd",
"other": "other required value"
}
],
"permission_groups": [{"id": "1"
}
],
"birthday": "2000-01-03T00:00:00Z",
"hire_date": "2019-01-03T00:00:00Z"
}

Response samples

application/json

{"results": {"type": "object",
"data": {"id": "25689",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567",
"type": {"id": "5",
"name": "full-time"
},
"company": {"id": "234",
"name": "KMPL Cannabis"
},
"facilities": [{"id": "12345",
"name": "KMPL Manufacturing",
"license": {"license_number": "KMPL20200818",
"type": {"name": "Type 12"
}
}
}
],
"occupational_licenses": [ ],
"credentials": [{"username": "jdoe@kmpl.com",
"password": "mysecurepassword",
"software_name": "metrc",
"state": "ca",
"api_key": "1234567889asfasdfafaasfd",
"other": "other required value"
}
],
"permission_groups": [{"id": "1",
"name": "Administration"
}
],
"birthday": "2000-01-03T00:00:00Z",
"hire_date": "2019-01-03T00:00:00Z",
"termination_date": "",
"entity_state": [{"state": "active",
"date": "2021-01-12T05:27:39Z",
"reason": "employee created",
"actioned_by": "admin@kmp.com"
}
]
}
},
"warnings": [ ]
}

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" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"

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

Response Schema: application/json

object

type

string

Value: "object"

object

string

Reference (entity_ID) for the employee.

object

The name of the employee.

first_name	string first name of the employee.
last_name	string last name of the employee.

email_address

string

The employee's email address.

phone_number

string

The phone number of the employee.

object

The type of employment (e.g. full-time, temporary, gig, etc.). List of available types can be obtained via the /config/employees/types endpoint).

id	string Reference (entity_ID) for the type of employment (e.g. full-time, temporary, gig, etc.)
name	string The display name of the employment type.

object

id	string Reference (entity_ID) for the company.
name	string Company name of the license holder.

Array of objects

The list of facilities the employee is authorized to work in.

Array

id	string
name	string
	object

Array of objects

A list of occupational licenses held by the employee.

Array

type	string The type of license the employee holds.
number	string The number of the license held by the employee.
issuing_state	string issuing state of the license, Lower case ANSI standard INCITS 38:2009 USPS codes of the US state

Array of objects

The list of credentials the employee has for the track & trace system(s) (NOTE: not used in some states).
Required if this employee will be using track & trace system(s).

Array

username	string The username of the employee used for the track & trace system.
password	string The password of the employee used for track & track system.
software_name	string The descriptive name of the track & trace software (e.g. metrc, biotrack, leafdata)
state	string The state the license was issued from.
api_key	string The api key the employee uses for the track and trace system from that state.
other	string Additional field for license information.

Array of objects

The list of permission groups the employee has been assigned.

Array

id	string The id of the permission_group
name	string The display name of the permissions_group

birthday

string

The employees birthday in ISO 8601 UTC format.

hire_date

string

The date the employee was hired in ISO 8601 UTC format.

termination_date

string or null

The date the employee's employment was terminated in ISO 8601 UTC format.

Array of objects

A list of state changes made to the entity. Entity states for employees [active, inactive, deleted]

Array

state	string state of the entity.
date	string timestamp when the state was recorded ISO 8601 UTC format.
reason	string additional information for the 'state' change.
actioned_by	string username of the person who updated the state of the entity (if applicable).

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/config/employees/{id}

Response samples

application/json

{"results": {"type": "object",
"data": {"id": "25689",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567",
"type": {"id": "5",
"name": "full-time"
},
"company": {"id": "234",
"name": "KMPL Cannabis"
},
"facilities": [{"id": "12345",
"name": "KMPL Manufacturing",
"license": {"license_number": "KMPL20200818",
"type": {"name": "Type 12"
}
}
}
],
"occupational_licenses": [ ],
"credentials": [{"username": "jdoe@kmpl.com",
"password": "mysecurepassword",
"software_name": "metrc",
"state": "ca",
"api_key": "1234567889asfasdfafaasfd",
"other": "other required value"
}
],
"permission_groups": [{"id": "1",
"name": "Administration"
}
],
"birthday": "2000-01-03T00:00:00Z",
"hire_date": "2019-01-03T00:00:00Z",
"termination_date": "",
"entity_state": [{"state": "active",
"date": "2021-01-12T05:27:39Z",
"reason": "employee created",
"actioned_by": "admin@kmp.com"
}
]
}
},
"warnings": [ ]
}

Update employee

Update employee registered under 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" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"

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

Request Body schema: application/json

required

object

license_number

required

string

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

object

The name of the employee.

first_name	string first name of the employee.
last_name	string last name of the employee.

email_address

string

The employee's email address.

phone_number

string

The phone number of the employee.

object

The type of employment (e.g. full-time, temporary, gig, etc.). List of available types can be obtained via the /employee_types endpoint).

id	string Reference (entity_ID) for the type of employment (e.g. full-time, temporary, gig, etc.). List of available types can be obtained via the /config/employees/types endpoint).

Array of objects

The list of facilities the employee is authorized to work in.

Array

string

Array of objects

A list of occupational licenses held by the employee.

Array

type	string The type of license the employee holds.
number	string The number of the license held by the employee.
issuing_state	string issuing state of the license, Lower case ANSI standard INCITS 38:2009 USPS codes of the US state

Array of objects

The list of credentials the employee has for the track & trace system(s) (NOTE: not used in some states).
Required if this employee will be using track & trace system(s).

Array

username	string The username of the employee used for the track & trace system.
password	string The password of the employee used for track & track system.
software_name	string The descriptive name of the track & trace software (e.g. metrc, biotrack, leafdata)
state	string The state the license was issued from.
api_key	string The api key the employee uses for the track and trace system from that state.
other	string Additional field for license information.

Array of objects

The list of permission groups the employee has been assigned. Required if this employee will be using track & trace system.

Array

id	string The id of the permission_group

birthday

string

The employees birthday in ISO 8601 UTC format.

hire_date

string

The date the employee was hired in ISO 8601 UTC format.

termination_date

string or null

The date the employee's employment was terminated in ISO 8601 UTC format.

Array of objects

A list of state changes made to the entity. Entity states for employees [active, inactive, deleted]

Array

state required	string The state of the entity.
date required	string Timestamp when the state was recorded ISO 8601 UTC format.
reason required	string Additional information for the 'state' change.
actioned_by required	string Username of the person who updated the state of the entity (if applicable).

Responses

200

Response Schema: application/json

object

type

string

Value: "object"

object

string

Reference (entity_ID) for the employee.

object

The name of the employee.

first_name	string first name of the employee.
last_name	string last name of the employee.

email_address

string

The employee's email address.

phone_number

string

The phone number of the employee.

object

The type of employment (e.g. full-time, temporary, gig, etc.). List of available types can be obtained via the /config/employees/types endpoint).

id	string Reference (entity_ID) for the type of employment (e.g. full-time, temporary, gig, etc.)
name	string The display name of the employment type.

object

id	string Reference (entity_ID) for the company.
name	string Company name of the license holder.

Array of objects

The list of facilities the employee is authorized to work in.

Array

id	string
name	string
	object

Array of objects

A list of occupational licenses held by the employee.

Array

type	string The type of license the employee holds.
number	string The number of the license held by the employee.
issuing_state	string issuing state of the license, Lower case ANSI standard INCITS 38:2009 USPS codes of the US state

Array of objects

The list of credentials the employee has for the track & trace system(s) (NOTE: not used in some states).
Required if this employee will be using track & trace system(s).

Array

username	string The username of the employee used for the track & trace system.
password	string The password of the employee used for track & track system.
software_name	string The descriptive name of the track & trace software (e.g. metrc, biotrack, leafdata)
state	string The state the license was issued from.
api_key	string The api key the employee uses for the track and trace system from that state.
other	string Additional field for license information.

Array of objects

The list of permission groups the employee has been assigned.

Array

id	string The id of the permission_group
name	string The display name of the permissions_group

birthday

string

The employees birthday in ISO 8601 UTC format.

hire_date

string

The date the employee was hired in ISO 8601 UTC format.

termination_date

string or null

The date the employee's employment was terminated in ISO 8601 UTC format.

Array of objects

A list of state changes made to the entity. Entity states for employees [active, inactive, deleted]

Array

state	string state of the entity.
date	string timestamp when the state was recorded ISO 8601 UTC format.
reason	string additional information for the 'state' change.
actioned_by	string username of the person who updated the state of the entity (if applicable).

Array of objects

Array

type	string
detail	string

400

Bad Request

put/{state}/v1/config/employees/{id}

Request samples

Payload

application/json

{"license": {"license_number": "KMPL20200818"
},
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"facilities": [{"id": "12345"
},
{"id": "12346"
}
],
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567",
"type": {"id": "5"
},
"credentials": [{"username": "jdoe@kmpl.com",
"password": "mysecurepassword",
"software_name": "metrc",
"state": "ca",
"api_key": "1234567889asfasdfafaasfd",
"other": "other required value"
}
],
"permission_groups": [{"id": "1"
}
],
"birthday": "2000-01-03T00:00:00Z",
"hire_date": "2019-01-03T00:00:00Z",
"entity_state": [{"state": "inactive",
"date": "2021-01-12T05:27:39Z",
"reason": "employee on leave",
"actioned_by": "admin@kmp.com"
}
]
}

Response samples

application/json

{"results": {"type": "object",
"data": {"id": "25689",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567",
"type": {"id": "5",
"name": "full-time"
},
"company": {"id": "234",
"name": "KMPL Cannabis"
},
"facilities": [{"id": "12345",
"name": "KMPL Manufacturing",
"license": {"license_number": "KMPL20200818",
"type": {"name": "Type 12"
}
}
},
{"id": "12346",
"name": "KMPL Manufacturing #2",
"license": {"license_number": "KMPL20200819",
"type": {"name": "Type 12"
}
}
}
],
"occupational_licenses": [ ],
"credentials": [{"username": "jdoe@kmpl.com",
"password": "mysecurepassword",
"software_name": "metrc",
"state": "ca",
"api_key": "1234567889asfasdfafaasfd",
"other": "other required value"
}
],
"permission_groups": [{"id": "1",
"name": "Administration"
}
],
"birthday": "2000-01-03T00:00:00Z",
"hire_date": "2019-01-03T00:00:00Z",
"termination_date": "",
"entity_state": [{"state": "inactive",
"date": "2021-01-12T05:27:39Z",
"reason": "employee on leave",
"actioned_by": "admin@kmp.com"
}
]
}
},
"warnings": [ ]
}

Delete employee

Delete employee.

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

id required	string Reference (entity_ID) for the employee you are deleting. Example: 1234
state required	string Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating. Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"

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

Request Body schema: application/json

required

object

license_number

required

string

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

Responses

200

Response Schema: application/json

object

type

string

Value: "object"

object

Trace

id	string Reference (entity_ID) for the employee.
deleted	boolean True if employee was deleted successfully, otherwise false.

Array of objects

Array

type	string
detail	string

400

Bad Request

delete/{state}/v1/config/employees/{id}

Request samples

Payload

application/json

{"license": {"license_number": "KMPL20200818"
}
}

Response samples

application/json

{"results": {"type": "object",
"data": {"id": "234",
"deleted": true
}
},
"warnings": [ ]
}

Retrieve employee types

Retrieve a list of employee types

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" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"

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

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

Response Schema: application/json

object

type

string

Value: "array"

Array of objects

Array

id	string Reference (ID) for the employee type.
name	string Short description/name of the employee type.

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/config/employees/types

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "1",
"name": "full-time"
},
{"id": "2",
"name": "part-time"
},
{"id": "3",
"name": "temporary"
},
{"id": "4",
"name": "gig"
}
]
},
"warnings": [ ]
}

➔ Next to Product