Factuarea APIDevelopers

List all packs

List the packs of the company with cursor-based pagination. - Filter by search, slug (also finds previous slugs), sku, tag, channel, status, availability[in] and updated[gte]. - Sort with sort on created, name or price (prefix - for descending). - view=storefront returns only the packs on sale on the web, without internal fields. - Conditional reads: send If-None-Match to get 304 with no body.

GET
/companies/{company}/packs

Authorization

AuthorizationBearer <token>

Your API key as a bearer token: fact_live_… in production, fact_test_… in sandbox. See the authentication guide.

In: header

Path Parameters

company*string

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Formatuuid

Query Parameters

date?|

Day (YYYY-MM-DD, company time zone) the promotion is resolved for; default today. A date-time uses its day. Malformed: 400 parameter_invalid_iso8601.

limit?integer

Number of objects to return, between 1 and 100 (default 25).

Default25
Range1 <= value <= 100
starting_after?string

Cursor for forward pagination: pass the id of the last object on the previous page (the next_cursor of the previous response).

Formatuuid
ending_before?string

Cursor for backward pagination: pass the id of the first object on the current page.

Formatuuid
slug?string

Pack slug. It also finds the packs that used it before. Exact match on slug.

sku?string

Pack SKU. Exact match on sku.

tag?string

Classification tag. Exact match on tag.

channel?string

Sales channel the pack is enabled for: documents or web. Exact match on channel.

Value in"documents" | "web"
status?string

Pack status: active, inactive or archived. Exact match on status.

Value in"active" | "inactive" | "archived"
availability?string

Availability: in_stock, low, out_of_stock or untracked. Supports several values with availability[in]. Exact match on availability.

Value in"in_stock" | "low" | "out_of_stock" | "untracked"
availability[in]?string

Availability: in_stock, low, out_of_stock or untracked. Supports several values with availability[in]. Comma-separated list. Any of the values matches.

updated[gte]?string

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

Formatdate-time
sort?string

Sort order: created, name, price ascending, or with a - prefix for descending (default created, oldest first).

Value in"created" | "-created" | "name" | "-name" | "price" | "-price"
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
view?string

Shape of the pack: all (default) returns the full pack, storefront only what a web shop may show, and only for packs on sale there; any other pack answers 404.

Default"all"
Value in"all" | "storefront"

Headers

If-None-Match?string

Conditional request: send the ETag you stored from a previous response of this operation (quoted, as received) to get 304 Not Modified without a body when the content has not changed. Omit it to always receive the full response.

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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json