FieldMappings.list

GET

/entities/FieldMappings

Returns all defined FieldMappings

Request

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/entities/FieldMappings?include-deleted&first&last&before&after&expand=expand=owner,sales_unit,account_relations.account&order-by=order-by=created,-modified&filter=&filter-op=&load-only=load-only=id,name,owner.id'

Responses

🟢200OK

application/json

list of FieldMappings

Body

Example

{
    "success": true,
    "data": [
        {
            "is_delete_protected": false,
            "id": "01234567-abcd-dcba-ffff-000000000000",
            "is_deleted": false,
            "modified": "2019-01-01T00:00:00",
            "created": "2019-01-01T00:00:00",
            "is_system": false,
            "mapping": "blob",
            "operation": 1,
            "source_entity_api_name": "string",
            "target_entity_api_name": "string",
            "type_mappings": "blob",
            "revision": 1,
            "source_entity_name": "string",
            "target_entity_name": "string",
            "documents": [
                "http://example.com"
            ]
        }
    ],
    "page_info": {
        "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
        "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
        "has_previous_page": true,
        "has_next_page": true
    }
}

🔴500Internal Server Error

Modified at 2025-10-29 12:50:57

FieldMappings.update

FieldMappings.create