List Deals

List CRM deals available to the API key's organization.

Requires the Export permission (read scope). Results use cursor-based pagination.

namestring nullable

Filter deals by name (case-insensitive partial match)

stagestring nullable

Filter by pipeline stage name (case-insensitive partial match)

closedboolean nullable

Filter by closed status: true for won/lost deals, false for open

ownerstring nullable

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

closeDateBeforestring nullable

Upper bound for close date (ISO 8601, e.g. 2025-06-30T00:00:00Z)

closeDateAfterstring nullable

Lower bound for close date (ISO 8601)

amountMinnumber nullable

Minimum deal amount

amountMaxnumber nullable

Maximum deal amount

lastActivityBeforestring nullable

Upper bound for last activity date (ISO 8601)

lastActivityAfterstring nullable

Lower bound for last activity date (ISO 8601)

limitinteger

Maximum number of results per page (1-50)

cursorstring nullable

Opaque pagination cursor from a previous response

Response

Successful Response