listContactCustomFields
The organization's contact custom-field DEFINITIONS.
The organization's contact custom-field DEFINITIONS (id, name, type: TEXT/NUMBER/DOLLAR/DATE/LINK/DROPDOWN, dropdown options, allowMultiple, defaultValue). DEFINITIONS ONLY: no contact's value appears here, and none is missing; a contact's answer is getContact customFields[].values (updateContact echoes the same shape). Each id is the customFieldId for addCustomFieldValues (createContact) / updateCustomFieldValues (updateContact) on one contact, or setContactsCustomField for a DROPDOWN across a selection. Create definitions with createContactCustomField.
curl https://server.goliathdata.com/api/v1/call \
-H "Authorization: Bearer $GOLIATH_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"operationId": "listContactCustomFields",
"variables": {}
}'import { GoliathClient } from '@goliath-data/sdk'
const goliath = new GoliathClient({
apiKey: process.env.GOLIATH_API_KEY!,
baseUrl: 'https://server.goliathdata.com',
})
const result = await goliath.contacts.listContactCustomFields()const res = await fetch('https://server.goliathdata.com/api/v1/call', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
operationId: 'listContactCustomFields',
variables: {}
}),
})
const { data, errors } = await res.json()Variables
None. Send "variables": {}.
Response
What comes back under data: a list shows as one entry, and a value as its type.
{
"data": {
"contactCustomFieldQuery": {
"getMyOrganizationsCustomFields": [
{
"id": "<ID>",
"name": "…",
"type": "DROPDOWN",
"description": "…",
"options": [
{
"id": "<ID>",
"label": "…"
}
],
"displayOrder": 0,
"allowMultiple": true,
"defaultValue": "…",
"matchInboundTextsByValue": true,
"hideOnContactRecord": true
}
]
}
}
}Errors
unknown_variableA variable the operation does not declare. A typo is refused rather than silently dropped.
unauthorizedNo bearer header, or the key is invalid or revoked.
insufficient_scopeThe key lacks the scope the operation requires.
forbiddenA referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.
Behaviour
A read. It rejects an Idempotency-Key header with 400 bad_request.