APICRMDealsGet Deals

Get Deals

List CRM deals in your organization with owner, contact and company names. Send paginated=true for a paged response that also includes counts and totals (pipeline amount, MRR, annual); without it the endpoint returns a plain array of every deal. Paged filters: search (deal name), activeTab (open | won | lost | my | all, default open), filterStage, filterPriority and filterDealType (comma-separated lists), filterCreated (today | week | month | 3months), sortBy (dealName, dealStage, amount, amountEffective, closeDate, priority, pipeline, createdAt, updatedAt), sortDir (asc | desc, default desc). pageSize defaults to 25, max 100.

Created: September 16, 2026

Updated: September 16, 2026

Overview

GET

https://dashboard.vinsi.ai/api/crm/deals

Request

Headers

Content-Type

string

application/json

x-api-key

string

REQUIRED

Query Params

paginated

string

OPTIONAL

Example: true

page

string

OPTIONAL

Example: 1

pageSize

string

OPTIONAL

Example: 25

search

string

OPTIONAL

Example: annual

activeTab

string

OPTIONAL

Example: open

filterStage

string

OPTIONAL

Example: Appointment Scheduled

filterPriority

string

OPTIONAL

Example: High

filterDealType

string

OPTIONAL

Example: New Business

filterCreated

string

OPTIONAL

Example: month

sortBy

string

OPTIONAL

Example: amount

sortDir

string

OPTIONAL

Example: desc

Response

{6 items"items":[1 item0:{22 items"id":int77
"dealName":string"Acme Dental - Annual Plan"
"dealStage":string"Appointment Scheduled"
"pipeline":string"Sales Pipeline"
"dealType":string"New Business"
"priority":string"High"
"amount":int12000
"type":string"one-time"
"billingFrequency":null
"recurringAmount":null
"closeDate":string"2026-10-31T00:00:00.000Z"
"contactId":int1042
"companyId":int318
"dealOwnerId":string"cmexampleuser0000000000001"
"organizationId":string"cmexampleorg00000000000001"
"createdAt":string"2026-09-05T16:00:00.000Z"
"updatedAt":string"2026-09-05T16:00:00.000Z"
"dealOwnerName":string"Jane Doe"
"contactName":string"Alex Morgan"
"companyName":string"Acme Dental"
"companyLogoUrl":null
"hasEngagement":boolfalse
}
]
"total":int1
"page":int1
"pageSize":int25
"counts":{5 items"my":int1
"all":int20
"open":int14
"won":int4
"lost":int2
}
"totals":{4 items"pipeline":int12000
"mrr":int0
"annual":int0
"seats":int0
}
}

Endpoint Explorer

Note: You must be already authenticated on https://dashboard.vinsi.ai/ to use this API tester.

GET

Headers

Content-Type: *

x-api-key: *

Query Params

paginated: *

page: *

pageSize: *

search: *

activeTab: *

filterStage: *

filterPriority: *

filterDealType: *

filterCreated: *

sortBy: *

sortDir: *

Response

No response yet. Click Send to test the API.