---
title: "Get a mapping program"
method: GET
path: "/mapping/{programId}"
tags: ["mapping"]
---

# Get a mapping program

`GET /mapping/{programId}`

Get a mapping program

## Path parameters

- `programId` string, required — Mapping Program ID

## Headers

- `Authorization` string, required
- `X-Disable-Hooks` 'true', required

## Response `200`

Response with status 200

- TypeMappingProgramResponse
  - `data` TypeMappingProgram, required
    - `rules` TypeMappingMappingRuleOrConfig[], required — Mapping rules
      - `name` string, required — Name of the mapping rule
      - `type` string, required
      - `config` unknown
      - `acceptedAt` string, date-time — Time the mapping rule was last updated
      - `acceptedBy` string — Actor ID
      - `metadata` unknown
      - `id` string — Mapping Rule ID
      - `confidence` integer — Confidence of the mapping rule
      - `createdBy` string — User ID
      - `createdAt` string, date-time — Time the mapping rule was created
      - `updatedAt` string, date-time — Time the mapping rule was last updated
      - `deletedAt` string, date-time — Time the mapping rule was deleted
    - `id` string — If this program was saved, this is the ID of the program
    - `namespace` string — Namespace of the program
    - `familyId` string — Mapping Family ID
    - `createdAt` string, date-time — If this program was saved, this is the time it was created
    - `createdBy` string — User ID
    - `sourceKeys` string[], required — Source keys
    - `destinationKeys` string[], required — Destination keys
    - `summary` TypeMappingProgramSummary
      - `totalRuleCount` integer, required — Total number of mapping rules
      - `addedRuleCount` integer, required — Number of mapping rules added
      - `deletedRuleCount` integer, required — Number of mapping rules deleted
    - `accessToken` string — If this program was saved, this token allows you to modify the program
    - `acceptedAt` string, date-time — If this program was accepted, this is the time it was accepted
    - `acceptedBy` string — Actor ID

## Other responses

- `400` — Error response with status 400
- `404` — Error response with status 404

---

[API](https://skmtc.net/flatfile/apis/api-reference.md) · [All operations](https://skmtc.net/flatfile/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/flatfile/api-reference/versions/9d3a9979cd96/schema)