FurniOpsDocs
API referenceVendor

Read an agreement and where the organisation stands

The newest published version of the agreement, with its full text and hash, the organisation's newest acceptance, and its standing: accepted, grace (an earlier acceptance counts until accept_by), required or unpublished. Vendors only: a retailer answers 403 permission_denied.

  • Scopesagreements:read
  • Rate classread
GET/v1/agreements/{kind}

The newest published version of the agreement, with its full text and hash, the organisation's newest acceptance, and its standing: accepted, grace (an earlier acceptance counts until accept_by), required or unpublished. Vendors only: a retailer answers 403 permission_denied.

Authorization

apiKey
AuthorizationBearer <token>

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

In: header

Path Parameters

kind*"vendor_data"

Which agreement

Value in

  • "vendor_data"

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/agreements/vendor_data"
{  "object": "org_agreement",  "kind": "vendor_data",  "status": "accepted",  "current": {    "object": "agreement",    "id": "string",    "kind": "vendor_data",    "version": 1,    "title": "string",    "body_markdown": "string",    "sha256": "string",    "material": true,    "grace_days": 0,    "published_at": "2019-08-24T14:15:22Z"  },  "acceptance": {    "object": "agreement_acceptance",    "id": "string",    "agreement": "string",    "kind": "vendor_data",    "version": 1,    "sha256": "string",    "signer": {      "user": "string",      "name": "string",      "title": "string"    },    "authority_confirmed": true,    "method": "click",    "ip": "string",    "user_agent": "string",    "accepted_at": "2019-08-24T14:15:22Z"  },  "accept_by": "2019-08-24T14:15:22Z"}

Accept an agreement for the organisation POST

Records that the signer accepts, for the organisation, exactly the version and text they were shown (its `version` and `sha256`), with their typed name and title and their statement that they may bind it. A version or hash that is not the newest answers 409 `conflict`: show the new text and ask again. Accepting a version already accepted returns the earlier acceptance. Owners and admins only; never an AI agent's tool.

Read the vendor's most read products GET

The vendor's products most read by retailers in the last 30 days, listing only those read by at least k distinct paying retailers, so no single retailer's reading shows.