Deals

List Deals

Get all deals with optional search and tag filtering.

NOTE: Archived deals are hidden unless show_archived=true. Each deal carries status_id; resolve names with dealStatuses.list.

get/deals

Request

Base URL
https://app.boei.help/api/v1
Auth
HTTP bearer

Query parameters

searchstring

Search by name, email, phone, or company.

Example:acme

show_archivedboolean

Include archived deals (default false).

tag_idinteger

Filter by CRM tag ID.

Example:1

Response

Example response

{
  "data": [
    {
      "id": 15,
      "uuid": "d8425283-e7ed-4f51-8144-1353073657a9",
      "status_id": null,
      "status": null,
      "row_id": null,
      "assigned_to": null,
      "assigned_user": null,
      "notification_id": null,
      "contact_id": null,
      "domain_id": null,
      "name": "Shields-Raynor deal",
      "email": "kris.lucienne@example.org",
      "phone": "+18089912817",
      "company": "Marquardt-Bergnaum",
      "source": "Manual",
      "notes": "Occaecati debitis perferendis ea accusantium et.",
      "external_url": null,
      "value": "838.00",
      "temperature": "warm",
      "outcome": null,
      "archived_at": null,
      "next_action_at": null,
      "next_auto_follow_up_at": null,
      "auto_follow_up_is_scheduled": false,
      "follow_ups_sent": null,
      "last_auto_follow_up_sent_at": null,
      "last_ai_draft": null,
      "last_ai_draft_at": null,
      "business": null,
      "follow_up_max": null,
      "created_at": "2026-09-10 08:15:02",
      "updated_at": "2026-09-10 08:15:02"
    },
    {
      "id": 16,
      "uuid": "c6e6f3e1-035b-4178-90a9-5401a502a626",
      "status_id": null,
      "status": null,
      "row_id": null,
      "assigned_to": null,
      "assigned_user": null,
      "notification_id": null,
      "contact_id": null,
      "domain_id": null,
      "name": "Ruecker-Abernathy deal",
      "email": "rylee.rogahn@example.org",
      "phone": "+19564507947",
      "company": "Roob-Bailey",
      "source": "Manual",
      "notes": "Asperiores explicabo et voluptates assumenda.",
      "external_url": null,
      "value": "8776.00",
      "temperature": "warm",
      "outcome": null,
      "archived_at": null,
      "next_action_at": null,
      "next_auto_follow_up_at": null,
      "auto_follow_up_is_scheduled": false,
      "follow_ups_sent": null,
      "last_auto_follow_up_sent_at": null,
      "last_ai_draft": null,
      "last_ai_draft_at": null,
      "business": null,
      "follow_up_max": null,
      "created_at": "2026-09-10 08:15:02",
      "updated_at": "2026-09-10 08:15:02"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.