FurniOpsDocs
API referenceCatalogue

List the catalogue's images

Every image the own catalogue's records name, newest first, with what FurniOps did with it: stored (with a short-lived preview link), pending, or failed and why.

  • Scopesproducts:read
  • Rate classread
GET/v1/catalogue/images

Every image the own catalogue's records name, newest first, with what FurniOps did with it: stored (with a short-lived preview link), pending, or failed and why.

Authorization

apiKey
AuthorizationBearer <token>

An API key (fo_live_… / fo_test_…) as a bearer token

In: header

Query Parameters

status?string

Only images in this state

Value in

  • "pending"
  • "stored"
  • "failed"
limit?integer

Page size

Range1 <= value <= 100
Default20
starting_after?string

Opaque position returned by a previous page

Match^[A-Za-z0-9_-]{1,512}$
ending_before?string

Opaque position returned by a previous page

Match^[A-Za-z0-9_-]{1,512}$

Header Parameters

FurniOps-Version?string

Dated API version; pinned per organisation on first use and overridable per request

Value in

  • "2026-10-01"
  • "2026-10-04"
FurniOps-Mode?string

The data the request acts on: test is the organisation's sandbox. An OAuth token picks it (live by default); an API key's mode is fixed, and naming the other one is refused

Value in

  • "live"
  • "test"
If-None-Match?string

ETag of a cached representation; a match returns 304

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/catalogue/images"
{  "object": "list",  "data": [    {      "object": "image",      "id": "string",      "url": "string",      "status": "pending",      "error": {        "code": "unavailable",        "message": "string"      },      "width": 1,      "height": 1,      "bytes": 1,      "preview_url": "http://example.com",      "attempts": 0,      "fetched_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z"    }  ],  "has_more": true,  "next_cursor": "string"}

Retrieve a publication run GET

One publication run and its progress.

List the catalogue's variants with price levels and stock GET

The own catalogue's variants by ID, each with its price levels (wholesale, MAP, MSRP), its availability and what looks wrong with them, narrowed by every filter given. The network's rows are never listed here.