List Products - Admin

Returns every product in the application, in any state including draft, for producers. Unlike List Products, it adds filters on display status, category name and gating. Requires a producer access token for the application. Results are paginated, and each result is a full product in the same shape as Retrieve Product.

get/{client_id}/products/admin/

Request

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

Path parameters

client_idstring required

The client ID of the application.

Query parameters

product_store_idstring uuid

Only products in this reward store.

category_idstring uuid

Only products listed under this category.

category_namestring

Only products in a category with this name. Case-insensitive exact match.

sponsor_idstring uuid

Only products with this sponsor.

product_type'badge' | 'multiplier' | 'flair' | 'common_code' | 'unique_code' | 'merchandise' | 'experience' | 'konekt'

Only products of this type.

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

Only products in this publication state.

status'draft' | 'unpublished' | 'published' | 'coming_soon' | 'expired'

Only products with this display status. Unlike state, it separates published products that are coming soon or expired.

is_gatedboolean

true returns only products restricted to profile groups, false only products open to everyone.

attributesstring

Format key:value, for example attributes=size:M. Repeating the parameter ANDs the pairs.

ordering'created_at' | '-created_at' | 'updated_at' | '-updated_at' | 'expiry_at' | '-expiry_at'

Sort field. Prefix with a minus for descending order.

pageinteger

Page number.

page_sizeinteger

Results per page. Defaults to 20.

Response

OK

countinteger
nextstring nullable

Changes

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