Skip to content

List Products (Admin)​

GET
/bridge-payment/admin/products

Admin endpoint to list all products with advanced filtering, search, and pagination. Supports filtering by category, type, recurring status, active status, and full-text search. Results can be ordered by multiple fields.

Pagination Methods (choose one):

  • Page-based: Use page parameter (1-based). Example: page=2&limit=10 returns products 11-20
  • Offset-based: Use offset parameter. Example: offset=20&limit=10 skips first 20 products
  • If both are provided, page takes priority
  • Default: limit=20, page=1 (or offset=0)

Example Requests:

  • Page-based: ?page=2&limit=10&product_type=subscription&is_active=true
  • Offset-based: ?offset=20&limit=10&search=premium&orderBy=name&orderDir=asc

Authorizations​

SessionAuth

Session ID from Flowless authentication

TypeAPI Key (header: X-Session-ID)

Parameters​

Query Parameters

page

Page number for pagination (1-based). Alternative to offset. If provided, takes priority over offset.

Typeinteger
Minimum1
Default1
limit

Number of products to return per page (default: 20)

Typeinteger
Default20
offset

Number of products to skip for pagination (default: 0). Alternative to page parameter.

Typeinteger
Default0
category_id

Filter by category ID

Typestring
product_type

Filter by product type

Typestring
Valid values
"physical""digital""service""subscription"
is_recurring

Filter by recurring status (string 'true' or 'false')

Typestring
Valid values
"true""false"
is_active

Filter by active status (string 'true' or 'false')

Typestring
Valid values
"true""false"
search

Search term to filter products by name or description

Typestring
orderBy

Field to sort results by (default: created_at)

Typestring
Valid values
"name""subtotal_cents""created_at""updated_at"
orderDir

Sort direction: 'asc' for ascending, 'desc' for descending (default: desc)

Typestring
Valid values
"asc""desc"

Responses​

List of products with pagination metadata

application/json
JSON
{
"success": true,
"data": [
{
"id": "string",
"name": "string",
"description": "string",
"product_type": "string",
"is_recurring": true,
"subtotal_cents": 0,
"tax_cents": 0,
"discount_cents": 0,
"total_cents": 0,
"currency": "string",
"billing_interval": "string",
"trial_days": 0,
"category_id": "string",
"is_active": true,
"created_at": "string",
"updated_at": "string"
}
],
"pagination": {
"total": 0,
"limit": 0,
"offset": 0,
"page": 0,
"pages": 0
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI