OpenAPI 3.1.02026-08-143874115.7 MB

a84d4905fdbb

Products

List Products

Returns a paginated list of products belonging to an account.

get/products

Query parameters

account_idstring required

The unique identifier of the account to list products for.

visibilitiesstring[]

Filter to only products matching these visibility states.

[
  "visible"
]
access_pass_typesstring[]

Filter to only products matching these types.

[
  "regular"
]
direction'asc' | 'desc'

The sort direction for results. Defaults to descending.

orderstring

The field to sort results by. Defaults to created_at.

firstinteger

The number of products to return (default and max 100).

afterstring

A cursor; returns products after this position.

lastinteger

The number of products to return from the end of the range.

beforestring

A cursor; returns products before this position.

Response

products listed

Example response

{
  "data": [
    {
      "created_at": "2026-01-01T12:00:00.000Z",
      "external_identifier": "SHINE-CERAMIC-01",
      "gallery_images": [
        {
          "content_type": "image/png",
          "id": "file_xxxxxxxxxxxxxx",
          "url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "headline": "A showroom finish that lasts three years",
      "id": "prod_xxxxxxxxxxxxxx",
      "metadata": {},
      "route": "ceramic-coating-package",
      "title": "Ceramic Coating Package",
      "updated_at": "2026-01-01T12:00:00.000Z",
      "visibility": "visible"
    }
  ],
  "page_info": {
    "end_cursor": "WyJjdXJzb3IiLDFd",
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}