HEhellobonsai
Deals

List deals

Lists the deals in your pipeline, a page at a time.

Filtering

  • filter[title] — searches deal titles, matching from the start of any word and ignoring case.
  • filter[deal_number] — searches deal references the same way.
  • filter[assignee_member_id] — one or more team member ids, or me for whoever the token belongs to.
  • filter[board_group_id] — one or more pipeline stage ids. Returns the deals sitting in those stages.
get/public-api/v1/deals

Request

  • Base URL
    https://app.hellobonsai.com
  • URL
    https://app.hellobonsai.com/public-api/v1/deals
  • Auth
    • OAuth 2
      Authorization code: https://app.hellobonsai.com/oauth/authorize
      Token URL: https://app.hellobonsai.com/oauth/token
    • or HTTP bearer

Query parameters

page[number]integer

Page to return, starting at 1.

page[size]integer

Records per page. Defaults to 25; anything above 100 is reduced to 100.

filter[title]string

Searches deal titles, matching from the start of any word and ignoring case.

filter[deal_number]string

Searches deal references, matching from the start of any word.

filter[assignee_member_id]string

One or more team member ids, comma-separated or repeated. Pass me for whoever the token belongs to.

filter[board_group_id]string

One or more pipeline stage ids, comma-separated or repeated. Returns the deals sitting in those stages.

Response

A page of deals.

Example response

{
  "data": [
    {
      "id": 918,
      "title": "Acme Website Redesign",
      "deal_number": "DL-42",
      "deal_value": "5000.00",
      "currency": "USD",
      "probability": 60,
      "close_date": "2026-09-30",
      "archived_at": "2026-04-14T09:12:04.000Z",
      "assignee_member_id": 314,
      "board_group_id": "8feddf83-f0dc-4587-ac77-3236d509a5c4",
      "status": "Won",
      "company_name": "Acme Corp",
      "assignee_member_name": "Maria Santos",
      "contact_ids": [
        7,
        12
      ],
      "url": "https://app.hellobonsai.com/deals?deal_id=918"
    }
  ],
  "meta": {
    "request_id": "b1f0d2c4-7a9e-4c3b-8d5f-1e2a3b4c5d6e",
    "pagination": {
      "page": 1,
      "page_size": 25,
      "has_more": true
    }
  }
}

Changes

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