Skip to main content
GET
/
custom-fields
List custom field definitions
curl --request GET \
  --url https://api.heffl.com/api/v2/custom-fields \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "key": "<string>",
      "label": "<string>",
      "dataType": "<string>",
      "required": true,
      "values": [
        "<string>"
      ],
      "pipelineId": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Query Parameters

​
entity
enum<string>
required

Resource type

Available options:
contacts,
companies,
deals,
quotations,
tasks
​
pipelineId
string

For entity=deals — filter to fields for this pipeline (dpl_ prefix)

Response

OK

​
data
object[]
required