Skip to main content
GET
/
api
/
v1
/
products
JavaScript
import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const productListProductsResponse of client.v1.products.listProducts()) {
  console.log(productListProductsResponse.id);
}
import os
from stigg import Stigg

client = Stigg(
api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted
)
page = client.v1.products.list_products()
page = page.data[0]
print(page.id)
package main

import (
"context"
"fmt"

"github.com/stiggio/stigg-go"
"github.com/stiggio/stigg-go/option"
)

func main() {
client := stigg.NewClient(
option.WithAPIKey("My API Key"),
)
page, err := client.V1.Products.ListProducts(context.TODO(), stigg.V1ProductListProductsParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}
package io.stigg.example;

import io.stigg.client.StiggClient;
import io.stigg.client.okhttp.StiggOkHttpClient;
import io.stigg.models.v1.products.ProductListProductsPage;
import io.stigg.models.v1.products.ProductListProductsParams;

public final class Main {
private Main() {}

public static void main(String[] args) {
StiggClient client = StiggOkHttpClient.fromEnv();

ProductListProductsPage page = client.v1().products().listProducts();
}
}
require "stigg"

stigg = Stigg::Client.new(api_key: "My API Key")

page = stigg.v1.products.list_products

puts(page)
using System;
using Stigg.Client;
using Stigg.Client.Models.V1.Products;

StiggClient client = new();

ProductListProductsParams parameters = new();

var page = await client.V1.Products.ListProducts(parameters);
await foreach (var item in page.Paginate())
{
Console.WriteLine(item);
}
stigg v1:products list-products \
--api-key 'My API Key'
curl --request GET \
--url https://api.stigg.io/api/v1/products \
--header 'X-API-KEY: <api-key>'
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.stigg.io/api/v1/products",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
{
  "data": [
    {
      "id": "product-revvenu",
      "displayName": "Revvenu",
      "description": "SaaS billing platform",
      "status": "PUBLISHED",
      "multipleSubscriptions": false,
      "metadata": {},
      "productSettings": {
        "downgradePlanId": "c9b0a382-5b7d-4d32-9f62-8c4e1a7b3d9f",
        "prorateAtEndOfBillingPeriod": null,
        "subscriptionCancellationTime": "END_OF_BILLING_PERIOD",
        "subscriptionEndSetup": "DOWNGRADE_TO_FREE",
        "subscriptionStartPlanId": "a1d4e8f2-6c3b-4a9e-b5f7-2d8c9e0f1a3b",
        "subscriptionStartSetup": "FREE_PLAN"
      },
      "createdAt": "2025-10-26T10:00:00.000Z",
      "updatedAt": "2025-10-26T10:00:00.000Z"
    }
  ],
  "pagination": {
    "next": "c9b0a382-5b7d-4d32-9f62-8c4e1a7b3d9f",
    "prev": "a1d4e8f2-6c3b-4a9e-b5f7-2d8c9e0f1a3b"
  }
}
{
"message": "<string>"
}
{
"message": "<string>",
"code": "Unauthenticated"
}
{
"message": "<string>"
}
{
"message": "<string>",
"code": "RateLimitExceeded"
}

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Query Parameters

after
string<uuid>

Return items that come after this cursor

before
string<uuid>

Return items that come before this cursor

limit
integer
default:20

Maximum number of items to return

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

Filter by entity ID

Maximum string length: 255
status
enum<string>[]

Filter by product status. Supports comma-separated values for multiple statuses

Available options:
PUBLISHED,
ARCHIVED
createdAt
object

Filter by creation date using range operators: gt, gte, lt, lte

Response

A paginated list of product objects.

Response list object

data
Product · object[]
required
pagination
object
required

Pagination metadata including cursors for navigating through results