Custom fields

4 endpoints at a glance

Method	Path	Summary
GET	/custom-fields	List Definitions
POST	/custom-fields	Create Definition
DELETE	/custom-fields/{def_id}	Delete Definition
PATCH	/custom-fields/{def_id}	Update Definition

custom-fields

---

List Definitions

GET

/custom-fields

Parameters

Header Parameters

authorization

Query Parameters

entity_type*

Type

string

Required

Valid values

"project""company""deal""task"

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/custom-fields

Playground

Headers

authorization

Variables

Key

Value

entity_type*

Samples

---

Create Definition

POST

/custom-fields

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"entity_type": "string",

  

"key": "string",

  

"label": "string",

  

"kind": "string",

  

"options": [

  

  

"string"

  

],

  

"required": false,

  

"position": 0,

  

"config": {

  

  

"additionalProperties": "string"

  

}

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/custom-fields

Playground

Headers

authorization

Body

Samples

---

Delete Definition

DELETE

/custom-fields/{def_id}

Delete the definition. Existing entity values under that key are
left intact (so a re-created definition can pick them back up).

Parameters

Header Parameters

authorization

Path Parameters

def_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/custom-fields/{def_id}

Playground

Headers

authorization

Variables

Key

Value

def_id*

Samples

---

Update Definition

PATCH

/custom-fields/{def_id}

Parameters

Header Parameters

authorization

Path Parameters

def_id*

Type

string

Required

Request Body

application/json

{

  

"label": "string",

  

"options": [

  

  

"string"

  

],

  

"required": true,

  

"position": 0,

  

"config": {

  

  

"additionalProperties": "string"

  

}

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/custom-fields/{def_id}

Playground

Headers

authorization

Variables

Key

Value

def_id*

Body

Samples

---