List products

Returns all products available to the authenticated API key's account.
Supports filtering, pagination, sorting, and field expansion.

💡 Tip: To attach product/copilot resources to a product, use the Resources endpoint (POST /resources) with the product_id field.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Expand allows you to return additional fields that are not included in the default fields (comma-separated list).

Supported fields:

  • languages: Languages this product supports

Note: component_tree expand is only available on GET /products/{id} (single product), not on this list endpoint.

string

Fields allows you to return a subset of the default fields (comma-separated list).

Supported fields:

  • aliases: Product aliases (array of external identifiers)
  • components: Product components (array of objects, each with at least id)
  • icon: Product icon filename
  • id: Product ID
  • name: Product name
  • status: 0 (unpublished) or 1 (published)
  • supplier_id: Supplier ID (populated if product is supplier-owned)
  • type: Product type (0=default, 1=hidden)
string

⚠️ IMPORTANT: The interactive form does not properly support filter syntax. Do NOT use the "Try It" button for filtering. Instead, copy the code samples (cURL, JavaScript, etc.) and modify the filter parameter directly.

Filter Format: filter[field][operator]=value

Invalid filter formats will return a 422 status code with detailed error information.

Supported operators:

  • eq: Equal to
  • neq: Not equal to
  • gt: Greater than
  • gte: Greater than or equal
  • lt: Less than
  • lte: Less than or equal
  • like: Contains (case-insensitive)

Supported fields:

  • aliases: Product aliases (array field - use contains operator to search within array)
  • bundle_id: Product bundle identifier
  • id: Product ID
  • name: Product name
  • parent_id: Parent product ID
  • status: 0 (unpublished) or 1 (published)
  • supplier_id: Filter by supplier ID
  • type: Product type (0=default, 1=hidden)
integer

Page number

integer
1 to 10000
Defaults to 100

Maximum number of results to return per page. Defaults to 100 if not specified. Maximum is 10,000. The response includes a more field indicating whether additional pages are available.

string

Fields to sort by

Responses

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