Weeek Public API
  1. Deals
Weeek Public API
  • Get started
  • Workspace
    • Tag
      • Tag list
      • Create tag
      • Tag
      • Update tag
      • Delete tag
    • Get workspace info
      GET
    • Get workspace members
      GET
  • Task Manager
    • Portfolio
      • Get portfolios
      • Create portfolio
      • Get portfolio
      • Update portfolio
      • Delete portfolio
    • Project
      • Custom Fields
        • Options
          • Create a custom field option
          • Update a custom field option
          • Move a custom field option
          • Delete a custom field option
        • Create a custom field
        • Update a custom field
        • Transfer custom field to task manager
        • Transfer custom field to project
        • Transfer custom field to board
        • Delete a custom field
      • Get project list
      • Create project
      • Update project info
      • Delete project
      • Get project
      • Archive project
      • Un Archive project
    • Board
      • Custom Fields
        • Options
          • Create a custom field option
          • Update a custom field option
          • Move a custom field option
          • Delete a custom field option
        • Create a custom field
        • Update a custom field
        • Transfer custom field to task manager
        • Transfer custom field to project
        • Transfer custom field to board
        • Delete a custom field
      • Get board list
      • Create board
      • Update board
      • Delete board
      • Move board
    • BoardColumn
      • Get board column list
      • Create board column
      • Update board column
      • Delete board column
      • Move board column
    • Task
      • Attachments
        • Upload attachments
      • Time Entries
        • Create a time entry
        • Update a time entry
        • Delete a time entry
      • Watchers
        • Add watchers to a task
        • Remove watchers from a task
      • Get tasks
      • Create task
      • Get one task info
      • Update a task
      • Delete task
      • Complete task
      • Un complete task
      • Change board
      • Change board column
    • Custom Fields
      • Options
        • Create global custom field option
        • Update global custom field option
        • Move global custom field option
        • Delete global custom field option
      • Get global custom fields
      • Create global custom field
      • Update global custom field
      • Transfer global custom field to project
      • Transfer global custom field to board
      • Delete global custom field
  • CRM
    • Funnels
      • Custom Fields
        • Options
          • Create a custom field option
          • Update a custom field option
          • Move a custom field option
          • Delete a custom field option
        • Create a custom field
        • Update a custom field
        • Move a custom field
        • Delete a custom field
      • Get all funnels
      • Create a funnel
      • Get a funnel
      • Update a funnel
      • Delete a funnel
    • Funnel Statuses
      • Get all funnel statuses
      • Create a funnel status
      • Get a funnel status
      • Update a funnel status
      • Delete a funnel status
    • Deals
      • Assignees
        • Attach an assignee
        • Detach an assignee
      • Contacts
        • Attach a contact
        • Detach a contact
      • Organizations
        • Attach an organization
        • Detach an organization
      • Tags
        • Attach a tag
        • Detach a tag
      • Tasks
        • Attach a new task
        • Move a attached to the deal task
        • Detach a task
      • Attachments
        • Upload attachments
      • Get all deals
        GET
      • Create a deal
        POST
      • Get a deal
        GET
      • Update a deal
        PUT
      • Update a deal fields
        PATCH
      • Move a deal
        POST
      • Delete a deal
        DELETE
      • Update the deal funnel
        PUT
      • Update the deal funnel status
        PUT
    • Organizations
      • Addresses
        • Create an address
        • Update the address
        • Delete the address
      • Emails
        • Create an email
        • Update the email
        • Delete the email
      • Phones
        • Create a phone
        • Update the phone
        • Delete the phone
      • Contacts
        • Attach a contact
        • Detach the contact
      • Tags
        • Attach a tag
        • Detach the tag
      • Get all organizations
      • Create an organization
      • Get an organization
      • Update an organization
      • Delete an organization
    • Contacts
      • Emails
        • Create an email
        • Update the email
        • Delete the email
      • Phones
        • Create a phone
        • Update the phone
        • Delete the phone
      • Tags
        • Attach a tag
        • Detach the tag
      • Get all contacts
      • Create a contact
      • Get a contact
      • Update a contact
      • Delete a contact
    • Currencies
      • Get all currencies
  • User
    • Get profile
  • Attachments
    • Get an attachment
  1. Deals

Get all deals

GET
https://api.weeek.net/public/v1/crm/statuses/{statusId}/deals
CRM.Deal

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
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

🟢200Success
application/json
Body
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
{
  "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": "number",
                "precision": 0,
                "currency": 1
              },
              "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": "number",
            "precision": 0,
            "currency": 1
          },
          "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
}
Previous
Upload attachments
Next
Create a deal
Built with