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

# FieldMappings.get

`GET /entities/FieldMappings/{id}`

## Request

- Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id`
- URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/FieldMappings/{id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/FieldMappings/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the FieldMapping record with the given id.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `expand` string

## Response `200`

The FieldMapping record.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` FieldMapping: Rules for copying field values from a source record to a new target record, for example when a lead is qualified into an opportunity.
    - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
    - `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: Situation in which the mapping pre-fills a new target record from a source record, such as qualifying a lead into an opportunity or creating a follow-up activity. 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

- `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
- `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
- `404`: No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE).
- `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
- `500`: Unexpected server error (code 1000, ERROR_UNKNOWN).

---

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