FurniOpsDocs
API referenceUploads

Retrieve an upload

One upload: its status and, once completed, the run reading it. No target.

  • Scopesruns:read
  • Rate classread
GET/v1/uploads/{id}

One upload: its status and, once completed, the run reading it. No target.

Authorization

apiKey
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Upload (a file sent to a source, staged in storage) ID

Match^upl_[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/uploads/string"
{  "object": "upload",  "id": "string",  "source": "string",  "filename": "string",  "content_type": "text/csv",  "bytes": 1,  "status": "pending",  "run": "string",  "target": {    "method": "PUT",    "url": "http://example.com",    "headers": {      "property1": "string",      "property2": "string"    },    "expires_at": "2019-08-24T14:15:22Z"  },  "expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "completed_at": "2019-08-24T14:15:22Z"}

Start an upload POST

Stages a file for a `file` source: the response's `target` is a presigned URL to PUT the bytes to, with the headers to send, for 15 minutes. Then complete the upload. Other kinds of source, and a file larger than the snapshot limit, answer 422.

Confirm a mapping POST

Confirms the mapping, as proposed or with the columns given, and applies it: a file waiting in `needs_mapping` resumes, or the source's current snapshot is replayed. Confirming again with new columns changes it the same way. Columns that are not among the headers, a field mapped twice, or settings that do not fit the field answer 422; a source with an active run, or a paused or disabled one, answers 409.