Skip to main content

List Products

GET 

/api/products

List all products.

Supports both authenticated users (JWT token) and public access (API key or no auth).

  • Authenticated users: Send JWT token in Authorization header
  • Public access: Send API key in X-API-Key header or pk query parameter, or no auth for public products

Query Parameters:

  • product_type: Can be sent as comma-separated (e.g., "PACKAGE,PACKAGE-ADDON") or array format (e.g., product_type[]=PACKAGE&product_type[]=PACKAGE-ADDON)

  • status: Product status filter (ACTIVE, ARCHIVED, etc.)

  • search: Search term to filter products by name or description (case-insensitive)

  • If no product_type specified: Returns all products EXCEPT PACKAGE and PACKAGE-ADDON (default behavior)

  • If product_type specified: Returns only products of the specified type(s)

  • SERVICE products are shared across all tenants

  • Other products are tenant-specific for proper isolation

Valid product types: STANDARD, SERVICE, PACKAGE, PACKAGE-ADDON Invalid types in comma-separated lists will be filtered out with a warning.

Request

Responses

Successful Response