Categories

Lists the organization's item categories, one page at a time.

Requires ViewInventory. Categories are flat with a parentCategoryId; nest them client-side. The built-in system category is not listed. Example: GET /api/v1/categories?parentCategoryId=0 returns the top-level categories. Also available as CSV (Accept: text/csv or ?format=csv); paging cursor in X-Next-Cursor.

get/api/v1/categories

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/categories
  • Auth: HTTP bearer

Query parameters

searchstring

Case-insensitive substring of the name, e.g. lum.

parentCategoryIdinteger

Only direct children of this category; 0 for top-level categories only.

updatedSincestring date-time

Only categories created or edited at/after this UTC instant (ISO-8601).

afterstring

SyncId of the last category of the previous page; omit for the first page.

limitinteger

Page size, 1-200 (default 50).

format'csv'

Alternative to the Accept header: csv returns text/csv.

Response

A page of categories.

nextCursorstring nullable

SyncId of the last item; pass it back as ?after= to fetch the next page. null when this is the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.