API Reference

List Products

Returns a list of your products. The products are returned sorted by creation date, with the most recent products appearing first. Supports advanced filtering by category and status.

Authentication

Authenticate your account by including your secret key in the request headers.

X-API-Key:bf_live_************************

Query Parameters

ParameterDescription
limit
Integer -- Default: 10
A limit on the number of objects to be returned. Limit can range between 1 and 100.
category_id
String -- Optional
Only return products belonging to the specified category identifier.
active
Boolean -- Optional
Filter products based on their current active status in the storefront.

HTTP Status Codes

200
Success
The request was successful
401
Unauthorized
Invalid or missing API key
Request
GET/v1/products
curl https://api.baoforge.com/v1/products \
  -H "X-API-Key: bf_live_..." \
  -G -d limit=5 \
  -d active=true
Response200 OK
{
  "object": "list",
  "url": "/v1/products",
  "has_more": false,
  "data": [
    {
      "id": "prod_L9k2mJ",
      "name": "Titanium Casting Bolt",
      "active": true,
      "metadata": {
        "material": "Grade 5 Ti"
      }
    },
    {
      "id": "prod_K8p3nL",
      "name": "Heat Shield Mesh",
      "active": true
    }
  ]
}
API StatusSecurityContact Devs