Skip to main content
GET
List deals

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Query Parameters

limit
integer
default:25

Number of records per page.

Required range: x <= 200
page
integer

Page number.

pipeline_id
integer

Restrict to a specific pipeline.

stage_id
integer

Restrict to a specific pipeline stage.

status
enum<string>

Restrict to deals in this status.

Available options:
open,
won,
lost
business_account_id
integer

Restrict to deals on a specific company.

Response

Successful response

data
object[]