List custom field definitions

GET

/api/nova/customfields

Returns the account's custom field (user-defined field) definitions. Each entry contains the fieldId to use when writing customFields on create and update endpoints, the display label, the input type (for example INPUT_TEXT, INPUT_NUMBER, INPUT_DATE, YES_NO, DROPDOWN, MULTI_SELECT), the record types the field applies to, the allowed values for dropdown and multi-select fields and whether the field is mandatory. Accepts an optional recordType parameter (for example CONTACT, COMPANY, JOB, CANDIDATE, LEAD, OPPORTUNITY, PLACEMENT) to return only the definitions for that module; a 400 is returned for an unrecognised recordType. Returns 401 for an invalid API key.

Authorizations

privateApiKey

Type

API Key (query: apiKey)

Parameters

Query Parameters

apiKey*

apiKey

Type

string

Required

recordType

recordType

Type

string

Responses

OK

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"allowedValues": [

  

  

  

  

"string"

  

  

  

],

  

  

  

"id": "string",

  

  

  

"inputType": "string",

  

  

  

"label": "string",

  

  

  

"mandatory": true,

  

  

  

"recordTypes": [

  

  

  

  

"string"

  

  

  

]

  

  

}

  

],

  

"error": "string",

  

"message": "string",

  

"requestId": "string",

  

"success": true

}

GET

/api/nova/customfields

Playground

Authorization

privateApiKey

Variables

Key

Value

apiKey*

recordType

Samples