Skip to main content
GET
List custom field mappings
Returns the custom field mappings your team saved in the dashboard’s integration settings: one record per source, such as hubspot, salesforce or csv. The response is a plain array, not paginated, and empty when nothing is mapped.

What a mapping does

Each entry in fields (contacts) or lead_fields (leads) ties a field in the source to the name Salesfinity shows for it: When contacts are imported from a CRM, each mapped field becomes a custom field on the contact, with label set to internal_name. Records for some CRMs also carry deal_fields, account_fields, deal_field_mapping and account_field_mapping, which set the deal and account fields shown for that CRM.

Using mappings with contact lists

The custom_fields on contacts you send to Create a contact list and Add a contact to a list are free text: nothing checks them against these mappings. To give an API-created contact the same field a CRM import creates, use the mapping’s internal_name as the label:

Example

Authorizations

x-api-key
string
header
required

Team-scoped API key generated in the Salesfinity dashboard under Settings → Connections → API & Webhooks. A missing or invalid key returns HTTP 403.

Response

Every custom field mapping record for the team.

_id
string
required

ID of the mapping record.

source
enum<string>
required

The integration the mapping belongs to. csv holds the mapping used for CSV uploads.

Available options:
csv,
salesforce,
salesforce_sandbox,
salesloft,
outreach,
apollo,
hubspot,
attio,
active-campaign,
custom,
pipe-drive,
monday
team
string
required

ID of your team.

user
string

ID of the member who first saved the mapping.

fields
object[]

Mappings for contact fields.

lead_fields
object[]

Mappings for lead fields, for CRMs that have leads.

deal_fields
object[]

Deal fields to show, for CRMs that support them. Absent when not configured.

account_fields
object[]

Account fields to show, for CRMs that support them. Absent when not configured.

deal_field_mapping
object[]

Which CRM fields fill Salesfinity's standard deal fields. Absent when not configured.

account_field_mapping
object[]

Which CRM fields fill Salesfinity's standard account fields. Absent when not configured.

createdAt
string<date-time>
updatedAt
string<date-time>