Skip to main content

List schema mappings

GET 

/field_mappings

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

List schema mappings

Request

Header Parameters

    x-customer-id stringrequired

    The customer ID that uniquely identifies the customer in your application

    Example: my-customer-1
    x-provider-name stringrequired

    The provider name

    Example: salesforce

Responses

List of objects and their field mappings (if set)

Schema
  • Array [
  • object_name stringrequired
    object_type stringrequired

    Possible values: [common, standard]

    allow_additional_field_mappings booleanrequired
    schema_id stringrequired
    fields object[]required
  • Array [
  • name stringrequired

    The name of the field as set in the schema

    is_added_by_customer booleanrequired

    Whether the field was added by the customer (only applicable if the schema has allow_additional_field_mappings set to true)

    schema_mapped_name string

    The mapped named of the field as set in the schema by the developer. If set, the customer cannot override. Only one of schema_mapped_name or customer_mapped_name should be set.

    customer_mapped_name string

    The mapped name of the field as set by the customer. Only one of schema_mapped_name or customer_mapped_name should be set.

  • ]
  • ]
Loading...