List Categories

Returns the categories across the application's active reward stores. Reads are public, so no producer token is needed. Categories in every state (draft, published and unpublished) are returned, and deleted categories and categories of deleted stores are left out. Results are paginated, and each result is a category in the same shape as Retrieve Category.

Query parameters, all optional:

  • product_store_id: only categories of this store.
  • state: draft, published or unpublished.
  • attributes: key:value, for example attributes=tier:gold. Repeat the parameter to AND the pairs.
  • ordering: a field name, with a minus prefix for descending order.
  • page and page_size: pagination. The default page size is 20.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The client ID of the application.

Query Params
uuid

Only categories of this reward store.

string
enum

Only categories in this state.

Allowed:
integer

Page number.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json