Retrieve Plants

Retrieves a list of plants All active plants for the license_number are obtained, filtered by the query parameter(s) criteria.

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
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
limit
number

Optional parameter that allows you to specify a number to limit the results in the response. Default limit is 100.

Example: limit=100
offset
number

Optional parameter that allows you to offset records if the max number for the filter exceeds the limit.

Example: offset=0
barcode
string

Plant's tag that uniquely identifies it for tracking purposes.

Example: barcode=1KMP00000000099000015442
expand
string

The expand query parameter is used to include additional information for the child objects in the plants response.

Enum: "additives" "manicure" "harvest" "waste" "lots" "all"
entity_state
string

Queryable entity states for plant. Inactive will return harvested, destroyed, and/or deleted plants.

Enum: "active" "inactive" "immature" "vegetative" "flowering" "harvest_scheduled" "harvested" "updated" "onhold - for seized or similar" "destroy _scheduled" "destroyed" "converted" "cured"
start_date
string

Starting date for the time range of plant's modifications. Only applicable if entity_state query parameter is used.

Example: start_date=2020-09-04
end_date
string

End date for the time range of plant's modifications. Only applicable if entity_state query parameter is used.

Example: end_date=2020-09-05
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/plants
Response samples
application/json
{
  • "results": {
    }
}