Skip to main content
GET
/
v1
/
deals
List all deals
curl --request GET \
  --url https://api4.kinbox.com.br/v1/deals \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "value": 123,
      "status": "open",
      "pipelineId": "<string>",
      "stageId": "<string>",
      "customFields": {},
      "lostReason": [
        "<string>"
      ],
      "productsLostReason": [
        {}
      ],
      "products": [
        {
          "id": "<string>",
          "name": "<string>",
          "price": 123,
          "quantity": 123,
          "discount": 123,
          "discountType": "percentage",
          "total": 123
        }
      ],
      "lostReasonObs": "<string>",
      "wonLostDate": "2023-11-07T05:31:56Z",
      "dueDate": "2023-11-07T05:31:56Z",
      "contact": {
        "id": 123,
        "name": "<string>",
        "avatar": "<string>",
        "phone": "<string>",
        "email": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "isPrivate": true
      },
      "conversation": {
        "id": 123,
        "platformId": 123,
        "showPending": true,
        "lastMessageAt": "2023-11-07T05:31:56Z",
        "pendingAt": "2023-11-07T05:31:56Z"
      },
      "operatorId": 123,
      "groupId": 123,
      "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>",
        "importId": "<string>"
      }
    }
  ],
  "nextCursor": {}
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
number
default:10

A limit on the number of objects to be returned. Limit can range between 1 and 100.

​
cursor
string

A cursor for use in pagination. The cursor is the id of the last object returned in the previous request.

​
pipeline_id
string

Filter deals by pipeline id.

​
status
enum<string>

Filter deals by status (open, won, lost).

Available options:
open,
won,
lost
​
contact_id
string

Filter deals by the id of the contact associated with the deal.

​
created_at_from
string

Only return deals that were created after this date.

​
created_at_to
string

Only return deals that were created before this date.

​
won_lost_date_from
string

Only return deals that were won or lost after this date.

​
won_lost_date_to
string

Only return deals that were won or lost before this date.

Response

200 - application/json
​
data
object[]
required
​
nextCursor
object
required

Cursor for the next page. Null if there are no more results.