Skip to main content

List entity mappings.

GET 

/entity_mappings

deprecated

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

List entity 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 entity mappings

Schema
  • Array [
  • entity_id stringrequired
    entity_name stringrequired
    allow_additional_field_mappings booleanrequired
    object object
    type stringrequired

    Possible values: [standard, custom]

    name stringrequired
    from stringrequired

    Possible values: [developer, customer]

    field_mappings object[]required
  • Array [
  • entity_field stringrequired
    mapped_field string
    from string

    Possible values: [developer, customer]

    is_additional booleanrequired
  • ]
  • ]
Loading...