RevKeenDocs
StatusSupport
API Reference

List products

List products with pagination and optional search. --- **Related endpoints** - `POST /products` — Create product - `GET /products/{id}` — Get product by ID - `PATCH /products/{id}` — Update product - `PUT /products/external/{source}/{externalId}` — Upsert product by external ID - `PUT /products/external/batch` — Batch upsert products by external ID **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. **Pagination** Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.

GET
/products

List products with pagination and optional search.

Related endpoints

  • POST /products — Create product
  • GET /products/{id} — Get product by ID
  • PATCH /products/{id} — Update product
  • PUT /products/external/{source}/{externalId} — Upsert product by external ID
  • PUT /products/external/batch — Batch upsert products by external ID

Common errors

  • 400 invalid_request — malformed payload or failed validation.
  • 401 authentication_error — missing, invalid, expired, or revoked credential. Codes: authentication_failed, invalid_api_key, expired_api_key, api_key_revoked, session_invalid, merchant_required. Carries a WWW-Authenticate: Bearer challenge.

Pagination

Offset-based with limit (default 25, max 100) and offset. The response pagination block includes total and hasMore. See the pagination guide for SDK auto-paging helpers.

Authorization

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Query Parameters

page?integer

Page number

Range1 <= value
Default1
limit?integer

Maximum number of results (1-100)

Range1 <= value <= 100
Default20
search?string

Search term to filter products

Response Body

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl "https://api.revkeen.com/v2/products" \
  -H "x-api-key: $REVKEEN_API_KEY"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "object": "product",      "product_id": "string",      "name": "string",      "description": "string",      "kind": "subscription",      "pricing_model": "one_time",      "amount_minor": 0,      "currency": "string",      "interval": "string",      "interval_count": 0,      "trial_days": 0,      "fulfillment_type": "none",      "track_inventory": true,      "stock_quantity": 0,      "billing_anchor_rule": "same_day",      "billing_anchor_day": 0,      "first_charge_behavior": "immediate",      "end_behavior": "until_canceled",      "max_payments": 0,      "usage_meter_id": "string",      "slug": "string",      "is_active": true,      "is_archived": true,      "image_url": "string",      "tax_behavior": "string",      "tax_code": "string",      "metadata": {},      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "kind": "string",    "page": 0,    "limit": 0,    "total": 0,    "totalPages": 0  }}

Get product by ID GET

Get a product by its ID. Requires 'products:read' scope. --- **Related endpoints** - `GET /products` — List products - `POST /products` — Create product - `PATCH /products/{id}` — Update product - `PUT /products/external/{source}/{externalId}` — Upsert product by external ID - `PUT /products/external/batch` — Batch upsert products by external ID **Common errors** - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.

Update product PATCH

Update an existing product. Requires 'products:write' scope. --- **Related endpoints** - `GET /products` — List products - `POST /products` — Create product - `GET /products/{id}` — Get product by ID - `PUT /products/external/{source}/{externalId}` — Upsert product by external ID - `PUT /products/external/batch` — Batch upsert products by external ID **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).