v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB
CrmIntegrations

List CRM Integrations

Get a list of CRM Integrations

get/api/crm_integrations

Response

OK

Example response

{
  "crm_integrations": [
    {
      "config": {
        "data_source_accounts_config": {
          "description": "A company or person",
          "external_lookup_config": {
            "sort_field_name": "CreatedDate"
          },
          "external_name": "Account",
          "field_mappings": [
            {
              "external_object_name_for_id": "Account",
              "field_name": "Name",
              "heron_company_attribute_label": "owner_1_first_name",
              "max_length": 255,
              "overwrite_on_update": true,
              "regex_remove": "pattern",
              "required": true,
              "static_value": "static value",
              "value_mapping_name": "state",
              "value_type": "Text"
            }
          ],
          "key": "Account",
          "required_ids": [
            {
              "alias": "Company",
              "external_name": "Account"
            }
          ],
          "static_data": [
            {
              "key": "status",
              "value": "active"
            }
          ]
        },
        "default_id": {
          "alias": "Company",
          "external_name": "Account"
        },
        "object_configs": [
          {
            "description": "A company or person",
            "external_lookup_config": {
              "sort_field_name": "CreatedDate"
            },
            "external_name": "Account",
            "field_mappings": [
              {
                "external_object_name_for_id": "Account",
                "field_name": "Name",
                "heron_company_attribute_label": "owner_1_first_name",
                "max_length": 255,
                "overwrite_on_update": true,
                "regex_remove": "pattern",
                "required": true,
                "static_value": "static value",
                "value_mapping_name": "state",
                "value_type": "Text"
              }
            ],
            "key": "Account",
            "required_ids": [
              {
                "alias": "Company",
                "external_name": "Account"
              }
            ],
            "static_data": [
              {
                "key": "status",
                "value": "active"
              }
            ]
          }
        ],
        "policy_evaluation_config": {
          "external_object_name": "Opportunity",
          "failure_reason_external_name": "Failure_Reason__c",
          "result_external_name": "Submission_Result_from_Heron__c"
        },
        "value_mappings": [
          {
            "default_value": "Default",
            "description": "The status of the company",
            "mapping": {
              "CA": "California",
              "NY": "New York"
            },
            "name": "Status"
          }
        ]
      },
      "instance_url": "https://sandbox.salesforce.com",
      "is_enabled": true,
      "is_live": true
    }
  ]
}