FurniOpsDocs
API referenceCatalogue

Retrieve a publication run

One publication run and its progress.

  • Scopespublishing:read
  • Rate classread
GET/v1/catalogue/publication-runs/{id}

One publication run and its progress.

Authorization

apiKey
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Publication run (publishing, withdrawing, hiding or showing a vendor's products, in the background) ID

Match^pbr_[0-9A-Za-z]{22}$

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

application/problem+json

curl -X GET "https://example.com/v1/catalogue/publication-runs/string"
{  "object": "publication_run",  "id": "string",  "action": "publish",  "status": "queued",  "products": {    "total": 0,    "done": 0  },  "reason": "string",  "error": "string",  "created_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z"}

Read the organisation's own catalogue GET

The catalogue the organisation owns in the request's mode, with its product counts. A vendor's catalogue also says where its publication stands and, in `blocked_by`, why publishing would be refused now.

List the catalogue's images GET

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.