Skip to main content
GET
/
v1
/
deals
Get deals
curl --request GET \
  --url http://localhost:4000/v1/deals \
  --header 'Authorization: Bearer <token>'
{ "data": { "count": 123, "deals": [ { "id": 123, "accountId": 123, "contactId": 123, "eventCallId": 123, "value": 123, "currency": "<string>", "transactionType": "<string>", "createdAt": "<string>", "updatedAt": "<string>", "time": "<string>" } ] } }

Authorizations

​
Authorization
string
header
required

API key required in Authorization header. Format: iclosed-<token>

Query Parameters

​
contactId
integer
​
userIds
string
​
productIds
string
​
transactionType
enum<string>
Available options:
WON,
RECURRING,
DEPOSIT
​
contactStatuses
string
​
eventIds
string | null
​
search
string
​
limit
integer
default:20
Required range: 1 <= x <= 200
​
page
integer
default:0
Required range: x >= 0
​
orderBy
enum<string>
Available options:
asc,
desc
​
orderColumn
enum<string>
Available options:
id,
createdAt,
updatedAt,
time,
value
​
timeFrom
string
​
timeTo
string

Response

List of deals with count

​
data
object
required