USusehindsight
Deals

Get deals with filtering and pagination

Retrieve deals with flexible filtering, sorting, and pagination. Returns deal objects with all their properties and relationships. Use this for real-time data access and integrations.

get/deals

Request

  • Base URL
    https://app.usehindsight.com/api/v1
  • Auth
    HTTP bearer

Query parameters

page_sizeinteger

Number of deals per page

page_indexinteger

Zero-based page index

countboolean

If true, returns only the total count

sort'created_at' | 'updated_at' | 'close_date' | 'amount' | 'name'

Column to sort by

sort_order'asc' | 'desc'

Sort direction

columnsstring

Comma-separated list of columns to return

searchQuerystring

Fuzzy search across deal names

statusstring

JSON array of deal stages

owner_idsstring

JSON array of owner IDs

close_datestring

JSON object: {"from": "2026-01-01", "to": "2026-03-31"}

amountstring

JSON object: {"min": 10000, "max": 100000}

Response

Successful response

OR
integer required

Total count when count=true

Example response

[
  {
    "id": "deal_123",
    "name": "Acme Corp - Enterprise License",
    "amount": 50000,
    "status_id": "negotiation",
    "previous_status_id": "qualification",
    "close_date": "2026-03-15",
    "type": "New Business"
  }
]

Changes

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