Skip to main content
GET
List all deals

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
number
default:10

A limit on the number of objects to be returned. Limit can range between 1 and 100.

cursor
string

A cursor for use in pagination. The cursor is the id of the last object returned in the previous request.

pipeline_id
string

Filter deals by pipeline id.

status
enum<string>

Filter deals by status (open, won, lost).

Available options:
open,
won,
lost
contact_id
string

Filter deals by the id of the contact associated with the deal.

created_at_from
string

Only return deals that were created after this date.

created_at_to
string

Only return deals that were created before this date.

won_lost_date_from
string

Only return deals that were won or lost after this date.

won_lost_date_to
string

Only return deals that were won or lost before this date.

Response

200 - application/json
data
object[]
required
nextCursor
object | null
required

Cursor for the next page. Null if there are no more results.