List contact custom field definitions
curl --request GET \
--url https://my.jobin.cloud/api/openapi/v1/contacts/custom-field-definitions \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://my.jobin.cloud/api/openapi/v1/contacts/custom-field-definitions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.jobin.cloud/api/openapi/v1/contacts/custom-field-definitions"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)$headers=@{}
$headers.Add("x-api-key", "<api-key>")
$response = Invoke-WebRequest -Uri 'https://my.jobin.cloud/api/openapi/v1/contacts/custom-field-definitions' -Method GET -Headers $headers{
"items": [
{
"customFieldDefinitionId": "<string>",
"fieldName": "<string>",
"valueType": "freeText",
"options": [
{
"label": "<string>",
"value": "<string>"
}
],
"rangeConfig": {
"min": 123,
"max": 123,
"step": 123,
"unit": "<string>"
}
}
],
"nextOffset": 123
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"statusCode": 429,
"error": "Too Many Requests",
"message": "<string>",
"retryAfterSeconds": 123
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}Contacts
List contact custom field definitions
Find custom field IDs, types, and allowed values for contact imports and updates.
GET
/
contacts
/
custom-field-definitions
List contact custom field definitions
curl --request GET \
--url https://my.jobin.cloud/api/openapi/v1/contacts/custom-field-definitions \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://my.jobin.cloud/api/openapi/v1/contacts/custom-field-definitions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.jobin.cloud/api/openapi/v1/contacts/custom-field-definitions"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)$headers=@{}
$headers.Add("x-api-key", "<api-key>")
$response = Invoke-WebRequest -Uri 'https://my.jobin.cloud/api/openapi/v1/contacts/custom-field-definitions' -Method GET -Headers $headers{
"items": [
{
"customFieldDefinitionId": "<string>",
"fieldName": "<string>",
"valueType": "freeText",
"options": [
{
"label": "<string>",
"value": "<string>"
}
],
"rangeConfig": {
"min": 123,
"max": 123,
"step": 123,
"unit": "<string>"
}
}
],
"nextOffset": 123
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"statusCode": 429,
"error": "Too Many Requests",
"message": "<string>",
"retryAfterSeconds": 123
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}Use
customFieldDefinitionId from the items array to identify a workspace field in a contact write. List definitions include their allowed options, and range definitions include their configured bounds.
Pass nextOffset as the offset for the next request. A null offset means there are no more results.
Rate limit: 120 requests/minute per endpoint and workgroup. Details.