Skip to main content
GET
/
products
curl "https://api.alguna.io/products?page=1&limit=25" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "products": [
    {
      "id": "prod_02zBTaXIplpzpaI6CggiUA",
      "name": "Platform Fee",
      "description": "Monthly cost for accounting reconciliation software",
      "feeType": "fixed",
      "paymentTerms": "arrears",
      "billingFrequency": "recurring",
      "createdAt": "2025-02-24T11:50:06Z",
      "updatedAt": "2025-02-24T11:50:06Z"
    },
    {
      "id": "prod_02zBU4lgiRfwjkrCQtYTUI",
      "name": "User Seast",
      "description": "Number of User Seats",
      "feeType": "metered",
      "paymentTerms": "arrears",
      "billingFrequency": "recurring",
      "metricIds": ["mtr_02zBU3PJ3hJurtFSxDD3Ol"],
      "createdAt": "2025-02-24T12:09:59Z",
      "updatedAt": "2025-02-24T12:09:59Z"
    }
  ]
}

Retrieves a paginated list of all products. You can filter and sort the results using query parameters.

Query Parameters

page
integer
default:"1"
The page number to retrieve (1-indexed).
limit
integer
default:"10"
The number of products to return per page. Must be one of: 5, 10, 25, 50, or 100. Values exceeding 100 are capped automatically.
filters
string
A JSON-encoded array of filter objects. Each filter object has the following properties:
sort
string
Sort specification in field:order format. Order is either asc (ascending) or desc (descending).Sortable fields: name, fee_type, metric_ids, payment_terms.
curl "https://api.alguna.io/products?page=1&limit=25" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "products": [
    {
      "id": "prod_02zBTaXIplpzpaI6CggiUA",
      "name": "Platform Fee",
      "description": "Monthly cost for accounting reconciliation software",
      "feeType": "fixed",
      "paymentTerms": "arrears",
      "billingFrequency": "recurring",
      "createdAt": "2025-02-24T11:50:06Z",
      "updatedAt": "2025-02-24T11:50:06Z"
    },
    {
      "id": "prod_02zBU4lgiRfwjkrCQtYTUI",
      "name": "User Seast",
      "description": "Number of User Seats",
      "feeType": "metered",
      "paymentTerms": "arrears",
      "billingFrequency": "recurring",
      "metricIds": ["mtr_02zBU3PJ3hJurtFSxDD3Ol"],
      "createdAt": "2025-02-24T12:09:59Z",
      "updatedAt": "2025-02-24T12:09:59Z"
    }
  ]
}

items
array
List of product objects.
pageCount
integer
Total number of pages available based on the current limit.
limit
integer
The number of items per page used for this request.