Factuarea APIDevelopers

List all products

List products in your catalog with cursor-based pagination.

GET
/products
AuthorizationBearer <token>

In: header

Query Parameters

limit?integer

Number of objects to return. Integer between 1 and 100. Defaults to 25.

Default25
Range1 <= value <= 100
starting_after?string

Cursor for forward pagination. Use the uuid of the last object on the previous page.

Formatuuid
ending_before?string

Cursor for backward pagination. Use the uuid of the first object on the current page.

Formatuuid
sku?string

Product SKU. Exact match on sku.

sku[in]?string

Product SKU. Comma-separated list. Any of the values matches.

sku[contains]?string

Product SKU. Partial case-insensitive match (LIKE %term%) on sku.

name?string

Product name. Exact match on name.

name[contains]?string

Product name. Partial case-insensitive match (LIKE %term%) on name.

is_active?boolean

Filter by active / inactive products. Exact match on is_active.

created[gte]?string

Creation date (ISO 8601). Greater than or equal to the given value.

Formatdate-time
created[lte]?string

Creation date (ISO 8601). Less than or equal to the given value.

Formatdate-time
created[gt]?string

Creation date (ISO 8601). Strictly greater than the given value.

Formatdate-time
created[lt]?string

Creation date (ISO 8601). Strictly less than the given value.

Formatdate-time
price[gte]?number

Unit price. Greater than or equal to the given value.

price[lte]?number

Unit price. Less than or equal to the given value.

price[gt]?number

Unit price. Strictly greater than the given value.

price[lt]?number

Unit price. Strictly less than the given value.

in_stock?boolean

Filter by products with available stock (true → stock > 0) or out of stock (false → stock = 0). Exact match on in_stock.

low_stock?boolean

Filter by products with low stock (true → 0 < stock ≤ configured threshold) or with ample stock (false → stock > threshold). Exact match on low_stock.

tag?string

Filter by classification tag. Supports multiple values with tag[in]. Exact match on tag.

tag[in]?string

Filter by classification tag. Supports multiple values with tag[in]. Comma-separated list. Any of the values matches.

search?string

Free-text search. Escaped LIKE %term% (case-insensitive, max 80 chars) across the resource's key text columns, combined with the other filters (AND) and compatible with the cursor.

Lengthlength <= 80
metadata?

Filter by metadata key/value pairs using the deepObject syntax metadata[key]=value. Multiple pairs are combined with AND. Each key must match [A-Za-z0-9_.-]{1,64}; a maximum of 50 pairs is allowed (more → 422).

Headers

Factuarea-Version?string

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate
X-Active-Profile?string

Operate on behalf of a child company (gestoría master key): pass its public id (UUID v7) and the request runs against that child's data without changing the key's scope, tier or environment (omit to use the key's own company). Invalid UUID → 400 parameter_invalid_uuid; unknown or non-owned id → 404 profile_not_found. See the Acting on behalf guide.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json