GET
/
v3
/
deals
curl --request GET \
  --url https://api4.kinbox.com.br/v3/deals \
  --header 'Authorization: Bearer <token>'
{
  "totalCount": 123,
  "data": [
    {
      "id": "<string>",
      "_id": "<string>",
      "name": "<string>",
      "value": 123,
      "lostReason": [
        "<string>"
      ],
      "products": [
        {
          "id": "<string>",
          "name": "<string>",
          "price": 123,
          "quantity": 123,
          "discount": 123,
          "discountType": {},
          "total": 123
        }
      ],
      "lostReasonObs": "<string>",
      "wonLostDate": "2023-11-07T05:31:56Z",
      "dueDate": "2023-11-07T05:31:56Z",
      "status": "open",
      "contact": {
        "id": 123,
        "name": "<string>",
        "avatar": "<string>",
        "phone": "<string>",
        "email": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "isPrivate": true
      },
      "conversation": {
        "id": 123,
        "platformId": 123,
        "lastMessageAt": "2023-11-07T05:31:56Z",
        "showPending": true,
        "pendingAt": "<string>"
      },
      "operatorId": 123,
      "groupId": 123,
      "pipelineId": "<string>",
      "stageId": "<string>",
      "origin": "<string>",
      "campaign": "<string>",
      "authorType": "user",
      "authorId": {},
      "tagIds": [
        123
      ],
      "position": 123,
      "focusedCounts": 123,
      "tasks": {},
      "timeInStage": {},
      "lastStageChanged": "2023-11-07T05:31:56Z",
      "comments": 123,
      "context": {
        "automationId": "<string>"
      },
      "customFields": {},
      "workspaceId": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "lastUpdateAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
number
default:20
required
Required range: 1 <= x <= 500
offset
number
default:0
required
Required range: x >= 0
filters
object
conditions
object
stageId
string[]
sortedBy
object
sortBy
string
sort
object
contactId
string
status
enum<string>
Available options:
open,
won,
lost
date
enum<string>
Available options:
all,
current_month,
last_month,
last_3_months,
last_6_months,
last_12_months
meta
object
pipelineId
string
operatorId
string
groupId
string
tagId
string
ignoreRestrictions
boolean
includeOperatorDay
boolean
operatorIds
string[]
groupIds
string[]
productIds
string[]
tagIds
string[]
createdAtFrom
string
createdAtTo
string
wonLostAtFrom
string
wonLostAtTo
string
period
enum<string>
Available options:
today,
week,
month,
year,
last_year,
last_month,
last_3_months,
last_1h,
last_3h,
last_24h,
custom
periodMetric
string
periodFrom
string
periodTo
string
roleId
number
required
isOwner
boolean
required
userId
number
required

Response

200 - application/json

The response is of type object.