API reference

Sales

3 requests. Each shows the permission a key needs, what to send and what comes back.

On this page

How many deals have something nobody has opened yet (a new enquiry, an email, a quote's answer): the Sales menu's number

GET/v1/sales/counts

Permission: enquiry.view
Module: quotes
Answers: 200

Response object

unreadintegerrequired
-9007199254740991 to 9007199254740991

curl "https://app.workscope.co.uk/v1/sales/counts" \
  -H "Authorization: Bearer wsk_your_key_here"

Example response

{
  "unread": -9007199254740991
}

The company's sales stages in order (the board's columns), with how many deals each holds, and after how many quiet days a deal is flagged

GET/v1/sales/stages

Permission: enquiry.view
Module: quotes
Answers: 200

Response object

stagesarray of objectrequired
- iduuidrequired
- namestringrequired
- positionintegerrequired
  -9007199254740991 to 9007199254740991
- probabilityintegerrequired
  -9007199254740991 to 9007199254740991
- kindenumrequired
  One of "open", "won", "lost"
- keyenumrequiredcan be null
  One of "new", "contacted", "site_visit", "quoted", "won", "lost"
- dealsintegerrequired
  -9007199254740991 to 9007199254740991
goneQuietDaysintegerrequired
-9007199254740991 to 9007199254740991

curl "https://app.workscope.co.uk/v1/sales/stages" \
  -H "Authorization: Bearer wsk_your_key_here"

Example response

{
  "stages": [
    {
      "id": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
      "name": "Harbourside Dental",
      "position": -9007199254740991,
      "probability": -9007199254740991,
      "kind": "open",
      "key": "new",
      "deals": -9007199254740991
    }
  ],
  "goneQuietDays": -9007199254740991
}

Save the stages: rename, reorder, set how likely each is to win, add and remove open ones (their deals move to the stage given). Won and Lost stay at the end.

PUT/v1/sales/stages

Permission: enquiry.manage
Module: quotes
Answers: 200

Request body JSON

stagesarray of objectrequired
3–20 items
- iduuidoptional
- namestringrequired
  1–60 characters
- probabilityintegerrequired
  0 to 100
- kindenumrequired
  One of "open", "won", "lost"
moveToobjectoptional
Default {}
goneQuietDaysintegeroptional
1 to 365

Response object

stagesarray of objectrequired
- iduuidrequired
- namestringrequired
- positionintegerrequired
  -9007199254740991 to 9007199254740991
- probabilityintegerrequired
  -9007199254740991 to 9007199254740991
- kindenumrequired
  One of "open", "won", "lost"
- keyenumrequiredcan be null
  One of "new", "contacted", "site_visit", "quoted", "won", "lost"
- dealsintegerrequired
  -9007199254740991 to 9007199254740991
goneQuietDaysintegerrequired
-9007199254740991 to 9007199254740991

curl -X PUT "https://app.workscope.co.uk/v1/sales/stages" \
  -H "Authorization: Bearer wsk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "stages": [
      {
        "id": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
        "name": "Harbourside Dental",
        "probability": 0,
        "kind": "open"
      }
    ],
    "moveTo": {},
    "goneQuietDays": 1
  }'

Example response

{
  "stages": [
    {
      "id": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
      "name": "Harbourside Dental",
      "position": -9007199254740991,
      "probability": -9007199254740991,
      "kind": "open",
      "key": "new",
      "deals": -9007199254740991
    }
  ],
  "goneQuietDays": -9007199254740991
}