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.
get/{client_id}/categories/

Request

  • Base URL
    https://cf-blast.livelikecdn.com/api/v1/applications
  • URL
    https://cf-blast.livelikecdn.com/api/v1/applications/{client_id}/categories/
  • Auth
    API key in header Authorization

Path parameters

client_idstring required

The client ID of the application.

Query parameters

product_store_idstring uuid

Only categories of this reward store.

state'draft' | 'published' | 'unpublished'

Only categories in this state.

pageinteger

Page number.

Response

OK

countinteger
nextstring nullable

Changes

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