Get drivers
Lists the drivers belonging to the authenticated company, oldest first (ordered by creation time ascending). Soft-deleted drivers are excluded, and results never cross company boundaries.
Drivers only exist for companies whose compliance type is METRC or BIOTRACK; a company with any other compliance type simply returns an empty list here.
Results are paginated. The response next_page holds the URL of the following page, or null on the last page.
Required permission: settings_permissions_drivers.
Query parameters
Restrict the result to specific drivers by ID (the same ID returned as each driver's id). Repeat the bracketed key once per ID. Unknown IDs simply match nothing; an empty list is treated as no filter. At most 200 IDs may be given.
Filter to drivers by their creation datetime, given as a comma-separated start,end pair of ISO8601 datetimes (inclusive). Either bound may be omitted for an open-ended range: 2022-07-10T00:00:00Z, matches on or after that instant, ,2022-07-10T00:00:00Z matches on or before it.
Filter to drivers by their last-updated datetime, given as a comma-separated start,end pair of ISO8601 datetimes (inclusive). Either bound may be omitted for an open-ended range.
Page selector. Page size is fixed by the server; paginate by following the next_page URL in each response rather than building page selectors yourself — it is null on the last page. next_page uses page[after]=<cursor>, an opaque token marking where the next page resumes; pass it back exactly as given, and only to the endpoint that issued it. This is seek-based, so every page stays fast no matter how deep you page.
Response
A list of drivers
Changes
No recorded changes to this endpoint across all 1 revision of this API.