WorkscopeAPI Open Workscope

API reference

Emails

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

On this page

The emails sent for one record (a deal, a quote, an invoice): who to, and whether each arrived

GET/v1/emails

Permission
client.view
Answers
200

Parameters

NameInKind
relatedTypequeryenumrequiredOne of deal, quote, invoice, credit_note, purchase_order, applicant
relatedIdqueryuuidrequired

Response array of object

  • iduuidrequired
  • kindstringrequired
  • tostringrequired
  • subjectstringrequired
  • statusenumrequired

    One of "queued", "sent", "not_sent", "delivered", "bounced", "complained", "failed"

  • detailstringrequiredcan be null
  • sentAtstringrequiredcan be null
  • updatedAtstringrequired
  • createdAtstringrequired
  • byNamestringrequiredcan be null
curl "https://app.workscope.co.uk/v1/emails?relatedType=deal&relatedId=3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41" \
  -H "Authorization: Bearer wsk_your_key_here"

Example response

[
  {
    "id": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
    "kind": "text",
    "to": "2026-11-06",
    "subject": "text",
    "status": "queued",
    "detail": "text",
    "sentAt": "2026-11-06T09:30:00.000Z",
    "updatedAt": "2026-11-06T09:30:00.000Z",
    "createdAt": "2026-11-06T09:30:00.000Z",
    "byName": "Harbourside Dental"
  }
]

What each kind of email to clients says (the company's wording or Workscope's), and invoice reminders

GET/v1/settings/emails

Permission
organization.update
Answers
200

Response object

  • templatesobjectrequired
    • subjectstringrequired
    • messagestringrequired
    • changedbooleanrequired
  • invoiceReminderDaysintegerrequiredcan be null

    -9007199254740991 to 9007199254740991

  • paymentReceivedEmailbooleanrequired
  • pdfsbooleanrequired
curl "https://app.workscope.co.uk/v1/settings/emails" \
  -H "Authorization: Bearer wsk_your_key_here"

Example response

{
  "templates": {},
  "invoiceReminderDays": -9007199254740991,
  "paymentReceivedEmail": false,
  "pdfs": false
}

Change the wording of emails to clients (null: back to Workscope's), and invoice reminders

PATCH/v1/settings/emails

Permission
organization.update
Answers
200

Request body JSON

  • templatesobjectoptional
  • invoiceReminderDaysintegeroptionalcan be null

    1 to 120

  • paymentReceivedEmailbooleanoptional

Response object

  • templatesobjectrequired
    • subjectstringrequired
    • messagestringrequired
    • changedbooleanrequired
  • invoiceReminderDaysintegerrequiredcan be null

    -9007199254740991 to 9007199254740991

  • paymentReceivedEmailbooleanrequired
  • pdfsbooleanrequired
curl -X PATCH "https://app.workscope.co.uk/v1/settings/emails" \
  -H "Authorization: Bearer wsk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "templates": {},
    "invoiceReminderDays": 1,
    "paymentReceivedEmail": false
  }'

Example response

{
  "templates": {},
  "invoiceReminderDays": -9007199254740991,
  "paymentReceivedEmail": false,
  "pdfs": false
}