Skip to main content
GET
List deals

Authorizations

Authorization
string
header
required

OAuth 2.1 access token.

Query Parameters

page
integer
default:1

Page number.

Required range: x >= 1
per_page
integer
default:50

Number of records per page. Maximum: 100.

Required range: 1 <= x <= 100
order_by
enum<string>
default:created_at

Field to sort by.

Available options:
created_at,
updated_at,
name
order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
name
string

Filter by deal name (case-insensitive partial match).

pipeline_id
string<uuid>

Filter by pipeline UUID.

stage_id
string<uuid>

Filter by stage UUID.

source
string

Filter by source (exact match). The source is the name of the OAuth app that created the deal.

forecast_after
string<date-time>

Filter deals with forecast_date on or after this date (ISO 8601).

forecast_before
string<date-time>

Filter deals with forecast_date on or before this date (ISO 8601).

created_after
string<date-time>

Filter deals created on or after this date (ISO 8601).

created_before
string<date-time>

Filter deals created on or before this date (ISO 8601).

updated_after
string<date-time>

Filter deals updated on or after this date (ISO 8601).

updated_before
string<date-time>

Filter deals updated on or before this date (ISO 8601).

Response

Deals listed successfully.

data
object[]
meta
object