Skip to main content
GET
List deals

Authorizations

X-API-Key
string
header
required

API key (sk_xxx) from Developer Settings. No X-Account-ID needed.

Headers

x-account-id
string | null

Query Parameters

categories
string | null

Comma-separated list of category IDs

custom_fields
string | null

JSON string of custom field filters

basic_filters
string | null

JSON string of basic filters

sort_by
string | null

Sort by field:direction, e.g., 'name:asc' or 'created_at:desc'

page
integer
default:1
Required range: x >= 1
page_size
integer
default:100
Required range: 1 <= x <= 1000
is_deleted
boolean | null
default:false
stage
string | null
status
string | null
company_id
string<uuid> | null
assigned_to_id
string<uuid> | null
min_amount
max_amount
expected_close_date_from
string<date> | null
expected_close_date_to
string<date> | null
enrichment_status
string | null
search
string | null

Response

Successful Response

items
Deal · object[]
required
total
integer
required
page
integer
required
page_size
integer
required
pages
integer
required