Skip to main content
GET
List all Deals

Authorizations

Authorization
string
header
required

Bearer Token necessary to use API

Query Parameters

expand
string[]

This endpoint supports expandable responses. For more, see the documentation page.

page
integer

Pagination: Page number

Required range: x >= 1
limit
integer

Pagination: Limit number of items per page.

Required range: 1 <= x <= 100
sort_by
enum<string>

Sorting by attribute. Default created_at

Available options:
created_at,
updated_at
sort_direction
enum<string>

Sorting by ASC or DESC direction. Default DESC

Available options:
ASC,
DESC
contact_id
string[]

Filter by Contact IDs. Supports multiple values separated by a comma.

site_id
string[]

Filter by Site IDs. Supports multiple values separated by a comma.

stage_id
string[]

Filter by Stage IDs. Supports multiple values separated by a comma.

created_after
string<date-time>

Filters results to created after (including given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

created_before
string<date-time>

Filters results to created before (excluding given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

updated_after
string<date-time>

Filters results to updated after (including given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

updated_before
string<date-time>

Filters results to updated before (excluding given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

assignee_id
string

Filter by Assignee ID. Supports multiple values separated by comma. Use unassigned for deals without an assignee.

status
enum<string>[]

Filter by deal status. Supports multiple values separated by comma.

Available options:
open,
won,
lost
lost_reason
enum<string>[]

Filter by lost reason. Supports multiple values separated by comma.

Available options:
accessibility_concern,
better_deal_elsewhere,
chose_competitor,
contract_terms,
decided_not_to_use_storage,
didnt_respond,
due_to_unstaffed_site,
facility_condition,
financial_reasons,
lack_of_response,
location_issues,
needs_extra_services,
no_longer_needed,
poor_customer_service,
price_concerns,
security_concerns,
size_availability,
timing,
unable_to_reach_customer,
unable_to_take_deliveries,
other

Response

200 - application/json

list of deals

List of Deals

deals
object[]
meta
object