Skip to main content
GET
/
deals
/
Get deals
curl --request GET \
  --url https://api-dev.iclosed.io/deals/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "data": [
    {
      "id": 123,
      "callId": 123,
      "productId": 123,
      "value": 123,
      "currency": "<string>",
      "transactionType": "<string>",
      "createdAt": "<string>",
      "contact": {
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "phoneNumber": "<string>",
        "status": "<string>"
      },
      "call": {
        "name": "<string>"
      },
      "product": {
        "name": "<string>",
        "price": 123
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

userId
integer

User ID to filter deals

callId
integer

Call ID to filter deals

value
number

Deal value to filter by

transactionType
enum<string>

Transaction type to filter by

Available options:
WON,
DEPOSIT,
RECURRING,
REFUND
productId
integer

Product ID to filter deals

page
integer
default:0

Page number for pagination (0-based)

Required range: x >= 0
limit
integer
default:50

Number of records per page (max 50)

Required range: 1 <= x <= 50

Response

Successfully retrieved deals

count
integer

Total number of deals matching the filters

data
object[]
I