List custom fields
curl --request GET \
--url https://client-api.salesfinity.co/v1/custom-fields \
--header 'x-api-key: <api-key>'import requests
url = "https://client-api.salesfinity.co/v1/custom-fields"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://client-api.salesfinity.co/v1/custom-fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://client-api.salesfinity.co/v1/custom-fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://client-api.salesfinity.co/v1/custom-fields"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://client-api.salesfinity.co/v1/custom-fields")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://client-api.salesfinity.co/v1/custom-fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"_id": "<string>",
"source": "csv",
"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"
}
]{
"message": "Forbidden resource",
"error": "Forbidden",
"statusCode": 403
}{
"message": "Too many requests",
"error": "Too Many Requests",
"statusCode": 429
}{
"message": "Internal server error",
"error": "Internal Server Error",
"statusCode": 500
}Custom Fields
Get Custom Fields
Returns all custom field mappings configured for the team. Custom fields represent field mappings between Salesfinity and integrated CRM platforms.
GET
/
v1
/
custom-fields
List custom fields
curl --request GET \
--url https://client-api.salesfinity.co/v1/custom-fields \
--header 'x-api-key: <api-key>'import requests
url = "https://client-api.salesfinity.co/v1/custom-fields"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://client-api.salesfinity.co/v1/custom-fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://client-api.salesfinity.co/v1/custom-fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://client-api.salesfinity.co/v1/custom-fields"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://client-api.salesfinity.co/v1/custom-fields")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://client-api.salesfinity.co/v1/custom-fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"_id": "<string>",
"source": "csv",
"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"
}
]{
"message": "Forbidden resource",
"error": "Forbidden",
"statusCode": 403
}{
"message": "Too many requests",
"error": "Too Many Requests",
"statusCode": 429
}{
"message": "Internal server error",
"error": "Internal Server Error",
"statusCode": 500
}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 identifiersource- Integration source (e.g.salesforce,hubspot)team- Team IDuser- User ID who configured the mappingfields- Array of contact field mappingstype- Field categoryfield_type- Data type of the fieldinternal_name- Salesfinity field nameexternal_key- CRM field keyexternal_name- CRM field display name
lead_fields- Array of lead field mappings (same structure asfields)createdAt- Creation timestampupdatedAt- Last update timestamp
Authorizations
Team-scoped API key generated in the Salesfinity dashboard under Settings -> Connections & API. A missing or invalid key returns HTTP 403.
Response
Custom fields retrieved successfully
Unique identifier
Integration source
Available options:
csv, salesforce, salesloft, outreach, apollo, hubspot, active-campaign, custom, pipe-drive, monday Team ID
User ID
Contact field mappings
Show child attributes
Show child attributes
Lead field mappings
Show child attributes
Show child attributes