Reference · Categories
List categories
/v1/sites/{siteId}/categoriesA site's categories, a page at a time. Retired categories are left out unless includeInactive is set.
Path
siteIdrequiredThe site, from GET /v1/sites.
string
Query
limitHow many records to return, at most.
integer · ≥ 1 · ≤ 200 · default 50
cursornextCursor from the previous page. Omit for the first page.
string
updatedSinceOnly records changed at or after this time (RFC 3339). For a sync, pass the time your previous sync started.
string · date-time
includeInactiveInclude retired records (active false). Off by default.
boolean
Headers
AuthorizationrequiredAn API key from Automation > Access in the Dnero portal, sent as
Authorization: Bearer <key>.string
Responses
- bad_requestinvalid_cursoridempotency_key_required
- missing_keyinvalid_keykey_expired+1 more
- key_revokedassistant_keykey_without_access+7 more
- site_not_foundnot_found
- invalid_requestnot_a_modifier_group
- rate_limited
- server_error
- upstream_unavailable
200 OK
datarequiredThe records, in a stable order.
array of objects
6 fields in each
activerequiredFalse for a retired category, which is listed only with includeInactive.
boolean
coderequiredThe category's code, the same at every site that has it.
string
namerequiredThe category's name.
string
orderrequiredWhere the category sits among the site's others, lowest first.
integer
defaultCourseCodeThe course a product in this category goes to the kitchen with, unless the product says otherwise.
string
updatedAtWhen the category last changed. Absent for one that has not changed since this was recorded.
string · date-time
nextCursorPass as cursor to get the next page. Absent on the last page.
string