---
title: "FieldMappings.get"
method: GET
path: "/entities/FieldMappings/{id}"
tags: ["Field"]
---

# FieldMappings.get

`GET /entities/FieldMappings/{id}`

Returns FieldMapping with given id

## Path parameters

- `id` string, uuid, required

## Response `200`

FieldMapping data

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` FieldMapping
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `id` string, uuid, required — Unique identifier of entity.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `is_system` boolean, required — True when the mapping is shipped by the platform and cannot be deleted by the user.
    - `mapping` string, binary — Default field-to-field mapping template applied when no per-type-pair mapping matches.
    - `operation` 1 | 2 | 3 | 4 | 5 | 6 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Default, 2 - Qualification, 3 - FollowUp, 4 - Parent, 5 - QualificationAndAutocreate, 6 - Conversion
    - `source_entity_api_name` string — API name of the source custom entity. Set only when source_entity_name is "CustomEntity"; otherwise empty.
    - `target_entity_api_name` string — API name of the target custom entity. Set only when target_entity_name is "CustomEntity"; otherwise empty.
    - `type_mappings` string, binary — Per-type-pair field mappings: each entry binds a set of source/target type ids and the field-to-field mapping that applies when both types match.
    - `revision` integer — Revision when entity was lastly changed.
    - `source_entity_name` string, required — Source entity kind for the mapping (e.g. Lead, Account, Contact). Returns "CustomEntity" when the source is a custom entity; the API name is then exposed via source_entity_api_name.
    - `target_entity_name` string, required — Target entity kind for the mapping (e.g. Lead, Account, Contact). Returns "CustomEntity" when the target is a custom entity; the API name is then exposed via target_entity_api_name.
    - `documents` string[] — Files attached to the mapping (e.g. import source files).

## Other responses

- `404` — Sent when invalid ID is given
- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/versions/e8c12ae60aca/schema)