deals

10 endpoints at a glance

Method	Path	Summary
GET	/deals	List Deals
POST	/deals	Create Deal
DELETE	/deals/{deal_id}	Delete Deal
GET	/deals/{deal_id}	Get Deal
PATCH	/deals/{deal_id}	Update Deal
GET	/deals/{deal_id}/members	List Members
POST	/deals/{deal_id}/members	Add Member
DELETE	/deals/{deal_id}/members/{member_username}	Remove Member
PATCH	/deals/{deal_id}/members/{member_username}	Change Member Role
POST	/deals/reorder	Reorder

deals

---

List Deals

GET

/deals

Parameters

Header Parameters

authorization

Query Parameters

pipeline_id

stage_id

status

q

page

Type

integer

Default

1

limit

Type

integer

Default

200

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/deals

Playground

Headers

authorization

Variables

Key

Value

pipeline_id

stage_id

status

q

page

limit

Samples

---

Create Deal

POST

/deals

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"name": "string",

  

"pipeline_id": "string",

  

"stage_id": "string",

  

"value": 0,

  

"currency": "EUR",

  

"expected_close_date": "string",

  

"owner_id": "string",

  

"tag_ids": [

  

  

"string"

  

]

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/deals

Playground

Headers

authorization

Body

Samples

---

Get Deal

GET

/deals/{deal_id}

Parameters

Header Parameters

authorization

Path Parameters

deal_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/deals/{deal_id}

Playground

Headers

authorization

Variables

Key

Value

deal_id*

Samples

---

Delete Deal

DELETE

/deals/{deal_id}

Parameters

Header Parameters

authorization

Path Parameters

deal_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/deals/{deal_id}

Playground

Headers

authorization

Variables

Key

Value

deal_id*

Samples

---

Update Deal

PATCH

/deals/{deal_id}

Parameters

Header Parameters

authorization

Path Parameters

deal_id*

Type

string

Required

Request Body

application/json

{

  

"name": "string",

  

"stage_id": "string",

  

"value": 0,

  

"currency": "string",

  

"expected_close_date": "string",

  

"owner_id": "string",

  

"tag_ids": [

  

  

"string"

  

],

  

"position": 0,

  

"custom_fields": {

  

  

"additionalProperties": "string"

  

}

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/deals/{deal_id}

Playground

Headers

authorization

Variables

Key

Value

deal_id*

Body

Samples

---

Reorder

POST

/deals/reorder

Kanban drag-drop. Same shape as /tasks/reorder.

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"items": [

  

  

{

  

  

  

"deal_id": "string",

  

  

  

"stage_id": "string",

  

  

  

"position": 0

  

  

}

  

]

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/deals/reorder

Playground

Headers

authorization

Body

Samples

---

List Members

GET

/deals/{deal_id}/members

Parameters

Header Parameters

authorization

Path Parameters

deal_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/deals/{deal_id}/members

Playground

Headers

authorization

Variables

Key

Value

deal_id*

Samples

---

Add Member

POST

/deals/{deal_id}/members

Parameters

Header Parameters

authorization

Path Parameters

deal_id*

Type

string

Required

Request Body

application/json

{

  

"username": "string",

  

"role": "editor"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/deals/{deal_id}/members

Playground

Headers

authorization

Variables

Key

Value

deal_id*

Body

Samples

---

Remove Member

DELETE

/deals/{deal_id}/members/{member_username}

Parameters

Header Parameters

authorization

Path Parameters

deal_id*

Type

string

Required

member_username*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/deals/{deal_id}/members/{member_username}

Playground

Headers

authorization

Variables

Key

Value

deal_id*

member_username*

Samples

---

Change Member Role

PATCH

/deals/{deal_id}/members/{member_username}

Parameters

Header Parameters

authorization

Path Parameters

deal_id*

Type

string

Required

member_username*

Type

string

Required

Request Body

application/json

{

  

"role": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/deals/{deal_id}/members/{member_username}

Playground

Headers

authorization

Variables

Key

Value

deal_id*

member_username*

Body

Samples

---