Skip to main content
GET
/
v1
/
custom-fields
cURL
curl --request GET \
  --url https://client-api.salesfinity.co/v1/custom-fields \
  --header 'x-api-key: <api-key>'
[
  {
    "_id": "<string>",
    "team": "<string>",
    "user": "<string>",
    "fields": [
      {
        "type": "<string>",
        "field_type": "<string>",
        "internal_name": "<string>",
        "external_key": "<string>",
        "external_name": "<string>"
      }
    ],
    "lead_fields": [
      {
        "type": "<string>",
        "field_type": "<string>",
        "internal_name": "<string>",
        "external_key": "<string>",
        "external_name": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]
Returns all custom field mappings configured for your team. Custom fields represent field mappings between Salesfinity and your integrated CRM platforms (Salesforce, HubSpot, etc.). Each record contains the integration source and the mapped fields for contacts and leads.

​
Response

Returns an array of custom field mapping records.
  • _id - Unique identifier
  • source - Integration source (e.g. salesforce, hubspot)
  • team - Team ID
  • user - User ID who configured the mapping
  • fields - Array of contact field mappings
    • type - Field category
    • field_type - Data type of the field
    • internal_name - Salesfinity field name
    • external_key - CRM field key
    • external_name - CRM field display name
  • lead_fields - Array of lead field mappings (same structure as fields)
  • createdAt - Creation timestamp
  • updatedAt - Last update timestamp

Authorizations

​
x-api-key
string
header
required

Response

200 - application/json

Custom fields retrieved successfully

​
_id
string
required

Unique identifier

​
source
enum<string>
required

Integration source

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

Team ID

​
user
string

User ID

​
fields
object[]

Contact field mappings

​
lead_fields
object[]

Lead field mappings

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