GET
List categories
Company space For: Manager · Permission: categories.list Conditions
  • Every company of the organization sees the same categories, whichever company created them; the company_id filter only narrows the list.
Part of Organize with options and categories.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: vat_rate_id, is_taxable, id, handle, title, image_url, sort_order, created_at, updated_at, organization_id.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: vat_rate, taxes.

Response

200 - application/json

Resource.

data
CategoryResource · object[]
required

Items of this page.

meta
object
required

Pagination details.