Get all deals

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

statusId

string

required

Query Params

string

optional

executorIds

array[string]

optional

winStatuses

array[string]

optional

Any value from enum: won, lost, archived

lastUpdated

array[string]

optional

Any value from enum: today, yesterday, lastWeek

tags

array[integer]

optional

tasks

array[object (Task) {29}]

optional

customFields

array[object (CustomFieldValue) {6}]

optional

attachments

array[object (Attachment) {7}]

optional

hasMoreDeals

boolean

optional

Example

{
  "success": true,
  "deals": [
    {
      "id": "string",
      "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
      "funnelId": "string",
      "statusId": "string",
      "assignees": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "organizations": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "contacts": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "title": "string",
      "description": "string",
      "amount": 0,
      "winStatus": "won",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "tags": [
        0
      ],
      "tasks": [
        {
          "id": 0,
          "parentId": 0,
          "title": "string",
          "description": "string",
          "duration": 0,
          "overdue": 0,
          "type": "action",
          "priority": 0,
          "isCompleted": true,
          "authorId": "string",
          "userId": "string",
          "boardId": 0,
          "boardColumnId": 0,
          "projectId": 0,
          "image": "string",
          "isPrivate": true,
          "startDate": "2019-08-24",
          "startDateTime": "2019-08-24T14:15:22Z",
          "dueDate": "2019-08-24",
          "dueDateTime": "2019-08-24T14:15:22Z",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "tags": [
            0
          ],
          "subscribers": [
            "string"
          ],
          "subTasks": [
            0
          ],
          "workloads": [
            {
              "id": "string",
              "userId": "string",
              "type": 1,
              "date": "string",
              "duration": 0,
              "workStartAt": "string",
              "workEndAt": "string"
            }
          ],
          "timeEntries": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
              "type": 1,
              "isOvertime": true,
              "date": "2019-08-24",
              "duration": 2
            }
          ],
          "customFields": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "name": "string",
              "type": "text",
              "config": {
                "type": "switch"
              },
              "options": [
                {
                  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                  "name": "string",
                  "color": "blue"
                }
              ],
              "value": "string"
            }
          ],
          "attachments": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
              "service": "weeek",
              "name": "string",
              "url": "http://example.com",
              "size": 0,
              "createdAt": "2019-08-24T14:15:22Z"
            }
          ]
        }
      ],
      "customFields": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "type": "text",
          "config": {
            "type": "switch"
          },
          "options": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "name": "string",
              "color": "blue"
            }
          ],
          "value": "string"
        }
      ],
      "attachments": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
          "service": "weeek",
          "name": "string",
          "url": "http://example.com",
          "size": 0,
          "createdAt": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ],
  "hasMoreDeals": true
}

Request

Responses