Retrieve harvest(s) details

Retrieve the harvest details. If the id is not provided, the details of all the active harvests 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"
id
required
string

Harvest ID

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

Display name of the harvest.

Example: name=Harvest strain 06122022 manicure A02
expand
string

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

Enum: "cure" "waste" "lots" "all"
entity_state
string

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

Enum: "active" "inactive" "curing" "cured" "updated" "finished" "unfinished" "onhold" "lab_testing_not_submitted" "lab_testing_submitted" "lab_testing_in_progress" "lab_testing_awaiting_confirmation" "lab_testing_passed" "lab_testing_failed" "lab_retesting_in_progress" "lab_retest_passed" "lab_retest_failed"
start_date
string

Starting date for the time range of harvest's modifications.

Example: start_date=2020-09-04
end_date
string

End date for the time range of harvest's modifications.

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