Weeek Public API
  • Get started
  • Workspace
  • Task Manager
  • CRM
    • Funnels
    • Funnel Statuses
    • Deals
      • Assignees
      • Contacts
      • Organizations
      • Tags
      • Tasks
      • Attachments
      • Get all dealsGET
      • Create a dealPOST
      • Get a dealGET
      • Update a dealPUT
      • Update a deal fieldsPATCH
      • Move a dealPOST
      • Delete a dealDELETE
      • Update the deal funnelPUT
      • Update the deal funnel statusPUT
    • Organizations
    • Contacts
    • Currencies
  • User
  • Attachments
logoPowered by Apidog
  1. CRM
  2. Deals

Get all deals

GET/crm/statuses/{statusId}/deals

Request

Authorization: Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example
Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379
Path Params
statusId
string 
required
Query Params
search
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[string]
optional
limit
integer 
optional

The number of objects to return

Example:
50
offset
integer 
optional

The number of objects to skip

Example:
0

Responses

Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
success
boolean 
optional
deals
array[object (Deal) {17}] 
optional
id
string 
read-onlyoptional

String identifier unique only within this resource in the workspace.

creatorId
string <uuid>
read-onlyoptional
funnelId
string 
read-onlyoptional
statusId
string 
read-onlyoptional
assignees
array[string <uuid>]
optional
organizations
array[string <uuid>]
optional
contacts
array[string <uuid>]
optional
title
string  | null 
optional
description
string  | null 
optional
amount
number <double> | null 
optional
winStatus
enum<string>  | enum<null> 
optional
Allowed values:
wonlostarchived
createdAt
string <date-time>
optional
updatedAt
string <date-time>
optional
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
Not configured
Last modified: 8 months ago