Skip to main content
GET
List custom field definitions

Authorizations

Authorization
string
header
required

API key from Settings > Developer. Format: alva_sk_...

Query Parameters

entity
enum<string>

Filter to one entity type

Available options:
company,
contact
includeArchived
boolean

Include archived (retired) fields

Response

Custom field definitions

data
object[]
resource
string
Example:

"custom_fields"