---
title: "The mapping tables a consumer's sync needs"
method: GET
path: "/consumers/{consumer_id}/syncs/{syncid}/mappings"
tags: ["Syncs"]
---

# The mapping tables a consumer's sync needs

`GET /consumers/{consumer_id}/syncs/{syncid}/mappings`

## Request

- Base URL: `https://api.chift.eu`
- URL: `https://api.chift.eu/consumers/{consumer_id}/syncs/{syncid}/mappings`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/chift/apis/chift-api/docs/consumers/:consumer_id/syncs/:syncid/mappings/get.ts> (a function with typed inputs; its response is checked against the schema)

Every mapping table the capabilities and modes running for this consumer need, with whether it is complete and whether it can stay hidden. Reads no connection: open a table to see its rows.

## Path parameters

- `consumer_id` string, uuid, required
- `syncid` string, uuid, required

## Query parameters

- `language` string, nullable: ISO 639-1 code of the language of the texts (en, fr, nl, de, es; any case), falling back to English. Without it, translation keys.

## Response `200`

Successful Response

- MappingTables: The mapping tables a consumer's running capabilities need.
  - `tables` MappingTableItem[], required: Every table the consumer's plan needs, in the plan's order.
    - `key` string, required: Stable key, e.g. 'spend_to_accounting.SupplierInvoices'. Send it back as is.
    - `id` string, uuid, required: The stable uuid derived from the key, as the legacy sync routes identify the same item.
    - `title` string, required: Name to show, in the requested language; its translation key without one.
    - `description` string, required: What it does, the tooltip: in the requested language, its translation key without one.
    - `used_by` string[], required: Keys of the capabilities or modes that need it.
    - `rows` string[], nullable, required: The rows in use when only some are. Null when the whole table is.
    - `required` boolean, required: A row without a value stops the objects that need it (an issue is raised).
    - `allow_delete` boolean, required: The consumer may hide rows.
    - `complete` boolean, required: No known row lacks a value. Rows the source lists are known once ai-fill or the consumer filled the table, rows met in the data once an execution or a preview met them.
    - `hidden` boolean, required: Nothing to show by default: the table is complete. It can still be opened and edited.

## Other responses

- `404`: Not Found
- `422`: Validation Error

## Changes

- **2026-11-03** `020884969534`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/chift/apis/chift-api/changes/consumers/:consumer_id/syncs/:syncid/mappings/get.md)

---

[API](https://skmtc.dev/chift/apis/chift-api.md) - [All operations](https://skmtc.dev/chift/apis/chift-api/llms.txt) - [OpenAPI document](https://skmtc.dev/chift/apis/chift-api/revisions/020884969534?raw)