FurniOpsDocs
API referenceMappings

Retrieve a mapping

One mapping: its headers, sample rows, mapped columns and what it could not place.

  • Scopessources:read
  • Rate classread
GET/v1/mappings/{id}

One mapping: its headers, sample rows, mapped columns and what it could not place.

Authorization

apiKey
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Mapping profile (how one header set of a source maps to canonical fields) ID

Match^map_[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/mappings/string"
{  "object": "mapping",  "id": "string",  "source": "string",  "status": "proposed",  "headers": [    "string"  ],  "samples": [    [      "string"    ]  ],  "columns": [    {      "column": "string",      "prefix": true,      "field": "group",      "settings": {},      "tier": "built_in"    }  ],  "unmapped": [    {      "column": "string",      "reason": "string"    }  ],  "confirmed_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

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.

List a source's mappings GET

The source's mappings, one per header set its files have had, newest first. A run that stopped as `needs_mapping` waits for its `proposed` one.