GET
/
products
List products
curl --request GET \
  --url https://api.funnelfox.io/public/v1/products \
  --header 'Fox-Secret: <fox-secret>'
{
  "data": [
    {
      "id": "<string>",
      "external_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "platform": "<string>",
      "status": "active",
      "pricing_summary": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 123,
    "has_more": true
  },
  "next_cursor": "<string>"
}

Headers

Fox-Secret
string
required

Project Secret Key

Example:

"secret_"

Query Parameters

limit
integer
default:20

Maximum number of items to return

Required range: 1 <= x <= 100
cursor
string

Cursor for pagination

filter[name]
string

Filter by product name (partial match)

filter[platform]
enum<string>

Filter by platform

Available options:
stripe,
paypal,
paddle,
braintree,
solidgate
filter[status]
enum<string>
default:active

Filter by status

Available options:
active,
archived

Response

200
application/json

Products list

The response is of type object.