Deals

List deals

get/v1/deals

Request

  • Base URL: https://app.getdealboard.com
  • URL: https://app.getdealboard.com/v1/deals
  • Auth: HTTP bearer

Query parameters

limitinteger

Max number of items per page (1-100).

cursorstring

Opaque cursor from a previous response's nextCursor.

boardIdstring uuid

Filter to one board.

stageIdstring

Filter to one stage (list a board's stages with GET /v1/boards/{id}/stages).

status'open' | 'won' | 'dead' | 'all'

Which deals to include. open (default) is the active pipeline only; won and dead are closed deals; all returns every non-deleted deal — use it for history lookups.

qstring

Case-insensitive substring search over deal name and company. Combine with status=all to find closed deals. This is the lookup to use when you have a name but no id (e.g. a Zapier "Find Deal" step).

Response

OK

hasMoreboolean required
nextCursorstring nullable required

Pass as ?cursor= on the next request to fetch the next page.

Changes

No recorded changes to this operation across all 1 revision of this API.