---
title: "List custom mappings"
method: GET
path: "/vault/custom-mappings/{unified_api}/{service_id}"
tags: ["Custom Mappings"]
---

# List custom mappings

`GET /vault/custom-mappings/{unified_api}/{service_id}`

This endpoint returns a list of custom mappings.

## Path parameters

- `unified_api` string, required
- `service_id` string, required

## Headers

- `x-apideck-consumer-id` string, required
- `x-apideck-app-id` string, required

## Response `200`

Custom mapping

- GetCustomMappingsResponse
  - `status_code` integer, required — HTTP Response Status Code
  - `status` string, required — HTTP Response Status
  - `data` CustomMapping[], required
    - `id` string — Target Field ID
    - `label` string — Target Field name to use as a label
    - `description` string, nullable — Target Field description
    - `value` string — Target Field Mapping value
    - `key` string — Target Field Key
    - `required` boolean — Target Field Mapping is required
    - `custom_field` boolean — This mapping represents a finder for a custom field
    - `consumer_id` string, nullable — Consumer ID
    - `example` string, nullable — Target Field Mapping example value from downstream
  - `_raw` Raw, nullable — Raw response from the integration when raw=true query param is provided

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `404` — The specified resource was not found
- `422` — Unprocessable
- `default` — Unexpected error

---

[API](https://skmtc.net/apideck-libraries/apis/vault-api.md) · [All operations](https://skmtc.net/apideck-libraries/apis/vault-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/apideck-libraries/vault-api/revisions/60e7fe7f5431/schema)