API reference

Issues

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

On this page

Issues the caller may see (a project or client, or all)

GET/v1/issues

Permission: issue.view
Module: issues
Answers: 200

Parameters

Name	In	Kind
`projectId`	query	uuid
`clientId`	query	uuid
`status`	query	enum	One of `open`, `in_progress`, `closed`
`q`	query	string
`reportedBy`	query	uuid
`assignedTo`	query	uuid
`unassigned`	query	enum	One of `true`, `false`
`from`	query	date
`to`	query	date
`closedSince`	query	date

Response array of object

iduuidrequired
projectIduuidrequired
projectNamestringrequired
clientIduuidrequired
clientNamestringrequired
statusenumrequired
One of "open", "in_progress", "closed"
dateReporteddaterequired
YYYY-MM-DD
detailsstringrequired
reportedByNamestringrequiredcan be null
reportedByUserIduuidrequiredcan be null
assignedToUserIduuidrequiredcan be null
assignedToNamestringrequiredcan be null
historyarray of objectrequired
- iduuidrequired
- kindenumrequired
  One of "status", "assignment"
- fromstringrequiredcan be null
- tostringrequiredcan be null
- byNamestringrequiredcan be null
- atstringrequired
notesarray of objectrequired
- iduuidrequired
- bodystringrequired
- authorNamestringrequiredcan be null
- minebooleanrequired
- createdAtstringrequired
photosarray of objectrequired
- iduuidrequired
- widthintegerrequired
  -9007199254740991 to 9007199254740991
- heightintegerrequired
  -9007199254740991 to 9007199254740991
- createdAtstringrequired
- thumbUrlstringrequired
- fullUrlstringrequired
closedAtstringrequiredcan be null
createdAtstringrequired
updatedAtstringrequired

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

Example response

[
  {
    "id": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
    "projectId": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
    "projectName": "1 Harbour Road",
    "clientId": "b7e6d5c4-3b2a-4190-8f7e-6d5c4b3a2918",
    "clientName": "Harbourside Dental",
    "status": "open",
    "dateReported": "2026-11-06",
    "details": "Side gate code is on the key safe.",
    "reportedByName": "Harbourside Dental",
    "reportedByUserId": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
    "assignedToUserId": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
    "assignedToName": "Harbourside Dental",
    "history": [
      {
        "id": "b7e6d5c4-3b2a-4190-8f7e-6d5c4b3a2918",
        "kind": "status",
        "from": "2026-11-06",
        "to": "2026-11-06",
        "byName": "Harbourside Dental",
        "at": "2026-11-06T09:30:00.000Z"
      }
    ],
    "notes": [
      {
        "id": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
        "body": "Side gate code is on the key safe.",
        "authorName": "Harbourside Dental",
        "mine": false,
        "createdAt": "2026-11-06T09:30:00.000Z"
      }
    ],
    "photos": [
      {
        "id": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
        "width": -9007199254740991,
        "height": -9007199254740991,
        "createdAt": "2026-11-06T09:30:00.000Z",
        "thumbUrl": "https://example.co.uk",
        "fullUrl": "https://example.co.uk"
      }
    ],
    "closedAt": "2026-11-06T09:30:00.000Z",
    "createdAt": "2026-11-06T09:30:00.000Z",
    "updatedAt": "2026-11-06T09:30:00.000Z"
  }
]

Report an issue on a project (operatives: on a booking assigned to them)

POST/v1/issues

Permission: issue.report
Module: issues
Answers: 201

Request body JSON

projectIduuidoptional
bookingIduuidoptional
detailsstringrequired
1–10000 characters
dateReporteddateoptional
YYYY-MM-DD
statusenumoptional
One of "open", "in_progress", "closed"

Response object

iduuidrequired
projectIduuidrequired
projectNamestringrequired
clientIduuidrequired
clientNamestringrequired
statusenumrequired
One of "open", "in_progress", "closed"
dateReporteddaterequired
YYYY-MM-DD
detailsstringrequired
reportedByNamestringrequiredcan be null
reportedByUserIduuidrequiredcan be null
assignedToUserIduuidrequiredcan be null
assignedToNamestringrequiredcan be null
historyarray of objectrequired
- iduuidrequired
- kindenumrequired
  One of "status", "assignment"
- fromstringrequiredcan be null
- tostringrequiredcan be null
- byNamestringrequiredcan be null
- atstringrequired
notesarray of objectrequired
- iduuidrequired
- bodystringrequired
- authorNamestringrequiredcan be null
- minebooleanrequired
- createdAtstringrequired
photosarray of objectrequired
- iduuidrequired
- widthintegerrequired
  -9007199254740991 to 9007199254740991
- heightintegerrequired
  -9007199254740991 to 9007199254740991
- createdAtstringrequired
- thumbUrlstringrequired
- fullUrlstringrequired
closedAtstringrequiredcan be null
createdAtstringrequired
updatedAtstringrequired

curl -X POST "https://app.workscope.co.uk/v1/issues" \
  -H "Authorization: Bearer wsk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
    "bookingId": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
    "details": "Side gate code is on the key safe.",
    "dateReported": "2026-11-06",
    "status": "open"
  }'

Example response

{
  "id": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
  "projectId": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
  "projectName": "1 Harbour Road",
  "clientId": "b7e6d5c4-3b2a-4190-8f7e-6d5c4b3a2918",
  "clientName": "Harbourside Dental",
  "status": "open",
  "dateReported": "2026-11-06",
  "details": "Side gate code is on the key safe.",
  "reportedByName": "Harbourside Dental",
  "reportedByUserId": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
  "assignedToUserId": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
  "assignedToName": "Harbourside Dental",
  "history": [
    {
      "id": "b7e6d5c4-3b2a-4190-8f7e-6d5c4b3a2918",
      "kind": "status",
      "from": "2026-11-06",
      "to": "2026-11-06",
      "byName": "Harbourside Dental",
      "at": "2026-11-06T09:30:00.000Z"
    }
  ],
  "notes": [
    {
      "id": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
      "body": "Side gate code is on the key safe.",
      "authorName": "Harbourside Dental",
      "mine": false,
      "createdAt": "2026-11-06T09:30:00.000Z"
    }
  ],
  "photos": [
    {
      "id": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
      "width": -9007199254740991,
      "height": -9007199254740991,
      "createdAt": "2026-11-06T09:30:00.000Z",
      "thumbUrl": "https://example.co.uk",
      "fullUrl": "https://example.co.uk"
    }
  ],
  "closedAt": "2026-11-06T09:30:00.000Z",
  "createdAt": "2026-11-06T09:30:00.000Z",
  "updatedAt": "2026-11-06T09:30:00.000Z"
}

One issue

GET/v1/issues/{id}

Permission: issue.view
Module: issues
Answers: 200

Parameters

Name	In	Kind
`id`	path	uuidrequired

Response object

iduuidrequired
projectIduuidrequired
projectNamestringrequired
clientIduuidrequired
clientNamestringrequired
statusenumrequired
One of "open", "in_progress", "closed"
dateReporteddaterequired
YYYY-MM-DD
detailsstringrequired
reportedByNamestringrequiredcan be null
reportedByUserIduuidrequiredcan be null
assignedToUserIduuidrequiredcan be null
assignedToNamestringrequiredcan be null
historyarray of objectrequired
- iduuidrequired
- kindenumrequired
  One of "status", "assignment"
- fromstringrequiredcan be null
- tostringrequiredcan be null
- byNamestringrequiredcan be null
- atstringrequired
notesarray of objectrequired
- iduuidrequired
- bodystringrequired
- authorNamestringrequiredcan be null
- minebooleanrequired
- createdAtstringrequired
photosarray of objectrequired
- iduuidrequired
- widthintegerrequired
  -9007199254740991 to 9007199254740991
- heightintegerrequired
  -9007199254740991 to 9007199254740991
- createdAtstringrequired
- thumbUrlstringrequired
- fullUrlstringrequired
closedAtstringrequiredcan be null
createdAtstringrequired
updatedAtstringrequired

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

Example response

{
  "id": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
  "projectId": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
  "projectName": "1 Harbour Road",
  "clientId": "b7e6d5c4-3b2a-4190-8f7e-6d5c4b3a2918",
  "clientName": "Harbourside Dental",
  "status": "open",
  "dateReported": "2026-11-06",
  "details": "Side gate code is on the key safe.",
  "reportedByName": "Harbourside Dental",
  "reportedByUserId": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
  "assignedToUserId": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
  "assignedToName": "Harbourside Dental",
  "history": [
    {
      "id": "b7e6d5c4-3b2a-4190-8f7e-6d5c4b3a2918",
      "kind": "status",
      "from": "2026-11-06",
      "to": "2026-11-06",
      "byName": "Harbourside Dental",
      "at": "2026-11-06T09:30:00.000Z"
    }
  ],
  "notes": [
    {
      "id": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
      "body": "Side gate code is on the key safe.",
      "authorName": "Harbourside Dental",
      "mine": false,
      "createdAt": "2026-11-06T09:30:00.000Z"
    }
  ],
  "photos": [
    {
      "id": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
      "width": -9007199254740991,
      "height": -9007199254740991,
      "createdAt": "2026-11-06T09:30:00.000Z",
      "thumbUrl": "https://example.co.uk",
      "fullUrl": "https://example.co.uk"
    }
  ],
  "closedAt": "2026-11-06T09:30:00.000Z",
  "createdAt": "2026-11-06T09:30:00.000Z",
  "updatedAt": "2026-11-06T09:30:00.000Z"
}

Change an issue's status, date or details

PATCH/v1/issues/{id}

Permission: issue.manage
Module: issues
Answers: 200

Parameters

Name	In	Kind
`id`	path	uuidrequired

Request body JSON

statusenumoptional
One of "open", "in_progress", "closed"
assignedToUserIduuidoptionalcan be null
dateReporteddateoptional
YYYY-MM-DD
detailsstringoptional
1–10000 characters

Response object

iduuidrequired
projectIduuidrequired
projectNamestringrequired
clientIduuidrequired
clientNamestringrequired
statusenumrequired
One of "open", "in_progress", "closed"
dateReporteddaterequired
YYYY-MM-DD
detailsstringrequired
reportedByNamestringrequiredcan be null
reportedByUserIduuidrequiredcan be null
assignedToUserIduuidrequiredcan be null
assignedToNamestringrequiredcan be null
historyarray of objectrequired
- iduuidrequired
- kindenumrequired
  One of "status", "assignment"
- fromstringrequiredcan be null
- tostringrequiredcan be null
- byNamestringrequiredcan be null
- atstringrequired
notesarray of objectrequired
- iduuidrequired
- bodystringrequired
- authorNamestringrequiredcan be null
- minebooleanrequired
- createdAtstringrequired
photosarray of objectrequired
- iduuidrequired
- widthintegerrequired
  -9007199254740991 to 9007199254740991
- heightintegerrequired
  -9007199254740991 to 9007199254740991
- createdAtstringrequired
- thumbUrlstringrequired
- fullUrlstringrequired
closedAtstringrequiredcan be null
createdAtstringrequired
updatedAtstringrequired

curl -X PATCH "https://app.workscope.co.uk/v1/issues/ID" \
  -H "Authorization: Bearer wsk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "open",
    "assignedToUserId": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
    "dateReported": "2026-11-06",
    "details": "Side gate code is on the key safe."
  }'

Example response

{
  "id": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
  "projectId": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
  "projectName": "1 Harbour Road",
  "clientId": "b7e6d5c4-3b2a-4190-8f7e-6d5c4b3a2918",
  "clientName": "Harbourside Dental",
  "status": "open",
  "dateReported": "2026-11-06",
  "details": "Side gate code is on the key safe.",
  "reportedByName": "Harbourside Dental",
  "reportedByUserId": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
  "assignedToUserId": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
  "assignedToName": "Harbourside Dental",
  "history": [
    {
      "id": "b7e6d5c4-3b2a-4190-8f7e-6d5c4b3a2918",
      "kind": "status",
      "from": "2026-11-06",
      "to": "2026-11-06",
      "byName": "Harbourside Dental",
      "at": "2026-11-06T09:30:00.000Z"
    }
  ],
  "notes": [
    {
      "id": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
      "body": "Side gate code is on the key safe.",
      "authorName": "Harbourside Dental",
      "mine": false,
      "createdAt": "2026-11-06T09:30:00.000Z"
    }
  ],
  "photos": [
    {
      "id": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
      "width": -9007199254740991,
      "height": -9007199254740991,
      "createdAt": "2026-11-06T09:30:00.000Z",
      "thumbUrl": "https://example.co.uk",
      "fullUrl": "https://example.co.uk"
    }
  ],
  "closedAt": "2026-11-06T09:30:00.000Z",
  "createdAt": "2026-11-06T09:30:00.000Z",
  "updatedAt": "2026-11-06T09:30:00.000Z"
}

Delete an issue

DELETE/v1/issues/{id}

Permission: issue.manage
Module: issues
Answers: 200

Parameters

Name	In	Kind
`id`	path	uuidrequired

Response object

okconstantrequired
Always true

curl -X DELETE "https://app.workscope.co.uk/v1/issues/ID" \
  -H "Authorization: Bearer wsk_your_key_here"

Example response

{
  "ok": true
}

Add a note to an issue

POST/v1/issues/{id}/notes

Permission: issue.note
Module: issues
Answers: 201

Parameters

Name	In	Kind
`id`	path	uuidrequired

Request body JSON

bodystringrequired
1–5000 characters

Response object

iduuidrequired
projectIduuidrequired
projectNamestringrequired
clientIduuidrequired
clientNamestringrequired
statusenumrequired
One of "open", "in_progress", "closed"
dateReporteddaterequired
YYYY-MM-DD
detailsstringrequired
reportedByNamestringrequiredcan be null
reportedByUserIduuidrequiredcan be null
assignedToUserIduuidrequiredcan be null
assignedToNamestringrequiredcan be null
historyarray of objectrequired
- iduuidrequired
- kindenumrequired
  One of "status", "assignment"
- fromstringrequiredcan be null
- tostringrequiredcan be null
- byNamestringrequiredcan be null
- atstringrequired
notesarray of objectrequired
- iduuidrequired
- bodystringrequired
- authorNamestringrequiredcan be null
- minebooleanrequired
- createdAtstringrequired
photosarray of objectrequired
- iduuidrequired
- widthintegerrequired
  -9007199254740991 to 9007199254740991
- heightintegerrequired
  -9007199254740991 to 9007199254740991
- createdAtstringrequired
- thumbUrlstringrequired
- fullUrlstringrequired
closedAtstringrequiredcan be null
createdAtstringrequired
updatedAtstringrequired

curl -X POST "https://app.workscope.co.uk/v1/issues/ID/notes" \
  -H "Authorization: Bearer wsk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "body": "Side gate code is on the key safe."
  }'

Example response

{
  "id": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
  "projectId": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
  "projectName": "1 Harbour Road",
  "clientId": "b7e6d5c4-3b2a-4190-8f7e-6d5c4b3a2918",
  "clientName": "Harbourside Dental",
  "status": "open",
  "dateReported": "2026-11-06",
  "details": "Side gate code is on the key safe.",
  "reportedByName": "Harbourside Dental",
  "reportedByUserId": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
  "assignedToUserId": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
  "assignedToName": "Harbourside Dental",
  "history": [
    {
      "id": "b7e6d5c4-3b2a-4190-8f7e-6d5c4b3a2918",
      "kind": "status",
      "from": "2026-11-06",
      "to": "2026-11-06",
      "byName": "Harbourside Dental",
      "at": "2026-11-06T09:30:00.000Z"
    }
  ],
  "notes": [
    {
      "id": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
      "body": "Side gate code is on the key safe.",
      "authorName": "Harbourside Dental",
      "mine": false,
      "createdAt": "2026-11-06T09:30:00.000Z"
    }
  ],
  "photos": [
    {
      "id": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
      "width": -9007199254740991,
      "height": -9007199254740991,
      "createdAt": "2026-11-06T09:30:00.000Z",
      "thumbUrl": "https://example.co.uk",
      "fullUrl": "https://example.co.uk"
    }
  ],
  "closedAt": "2026-11-06T09:30:00.000Z",
  "createdAt": "2026-11-06T09:30:00.000Z",
  "updatedAt": "2026-11-06T09:30:00.000Z"
}

Add a photo to an issue: send the image itself (JPEG, PNG, WebP; up to 15 MB)

POST/v1/issues/{id}/photos

Permission: issue.report
Module: issues
Answers: 201

Parameters

Name	In	Kind
`id`	path	uuidrequired

Request body the file itself

Send the file as the body, with Content-Type one of image/jpeg, image/png, image/webp, image/heic, image/heif. See Files and photos.

Response object

iduuidrequired
projectIduuidrequired
projectNamestringrequired
clientIduuidrequired
clientNamestringrequired
statusenumrequired
One of "open", "in_progress", "closed"
dateReporteddaterequired
YYYY-MM-DD
detailsstringrequired
reportedByNamestringrequiredcan be null
reportedByUserIduuidrequiredcan be null
assignedToUserIduuidrequiredcan be null
assignedToNamestringrequiredcan be null
historyarray of objectrequired
- iduuidrequired
- kindenumrequired
  One of "status", "assignment"
- fromstringrequiredcan be null
- tostringrequiredcan be null
- byNamestringrequiredcan be null
- atstringrequired
notesarray of objectrequired
- iduuidrequired
- bodystringrequired
- authorNamestringrequiredcan be null
- minebooleanrequired
- createdAtstringrequired
photosarray of objectrequired
- iduuidrequired
- widthintegerrequired
  -9007199254740991 to 9007199254740991
- heightintegerrequired
  -9007199254740991 to 9007199254740991
- createdAtstringrequired
- thumbUrlstringrequired
- fullUrlstringrequired
closedAtstringrequiredcan be null
createdAtstringrequired
updatedAtstringrequired

curl -X POST "https://app.workscope.co.uk/v1/issues/ID/photos" \
  -H "Authorization: Bearer wsk_your_key_here" \
  -H "Content-Type: image/jpeg" \
  --data-binary @photo.jpg

Example response

{
  "id": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
  "projectId": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
  "projectName": "1 Harbour Road",
  "clientId": "b7e6d5c4-3b2a-4190-8f7e-6d5c4b3a2918",
  "clientName": "Harbourside Dental",
  "status": "open",
  "dateReported": "2026-11-06",
  "details": "Side gate code is on the key safe.",
  "reportedByName": "Harbourside Dental",
  "reportedByUserId": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
  "assignedToUserId": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
  "assignedToName": "Harbourside Dental",
  "history": [
    {
      "id": "b7e6d5c4-3b2a-4190-8f7e-6d5c4b3a2918",
      "kind": "status",
      "from": "2026-11-06",
      "to": "2026-11-06",
      "byName": "Harbourside Dental",
      "at": "2026-11-06T09:30:00.000Z"
    }
  ],
  "notes": [
    {
      "id": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
      "body": "Side gate code is on the key safe.",
      "authorName": "Harbourside Dental",
      "mine": false,
      "createdAt": "2026-11-06T09:30:00.000Z"
    }
  ],
  "photos": [
    {
      "id": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
      "width": -9007199254740991,
      "height": -9007199254740991,
      "createdAt": "2026-11-06T09:30:00.000Z",
      "thumbUrl": "https://example.co.uk",
      "fullUrl": "https://example.co.uk"
    }
  ],
  "closedAt": "2026-11-06T09:30:00.000Z",
  "createdAt": "2026-11-06T09:30:00.000Z",
  "updatedAt": "2026-11-06T09:30:00.000Z"
}

Remove an issue photo

DELETE/v1/issues/{id}/photos/{photoId}

Permission: issue.manage
Module: issues
Answers: 200

Parameters

Name	In	Kind
`id`	path	uuidrequired
`photoId`	path	uuidrequired

Response object

iduuidrequired
projectIduuidrequired
projectNamestringrequired
clientIduuidrequired
clientNamestringrequired
statusenumrequired
One of "open", "in_progress", "closed"
dateReporteddaterequired
YYYY-MM-DD
detailsstringrequired
reportedByNamestringrequiredcan be null
reportedByUserIduuidrequiredcan be null
assignedToUserIduuidrequiredcan be null
assignedToNamestringrequiredcan be null
historyarray of objectrequired
- iduuidrequired
- kindenumrequired
  One of "status", "assignment"
- fromstringrequiredcan be null
- tostringrequiredcan be null
- byNamestringrequiredcan be null
- atstringrequired
notesarray of objectrequired
- iduuidrequired
- bodystringrequired
- authorNamestringrequiredcan be null
- minebooleanrequired
- createdAtstringrequired
photosarray of objectrequired
- iduuidrequired
- widthintegerrequired
  -9007199254740991 to 9007199254740991
- heightintegerrequired
  -9007199254740991 to 9007199254740991
- createdAtstringrequired
- thumbUrlstringrequired
- fullUrlstringrequired
closedAtstringrequiredcan be null
createdAtstringrequired
updatedAtstringrequired

curl -X DELETE "https://app.workscope.co.uk/v1/issues/ID/photos/ID" \
  -H "Authorization: Bearer wsk_your_key_here"

Example response

{
  "id": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
  "projectId": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
  "projectName": "1 Harbour Road",
  "clientId": "b7e6d5c4-3b2a-4190-8f7e-6d5c4b3a2918",
  "clientName": "Harbourside Dental",
  "status": "open",
  "dateReported": "2026-11-06",
  "details": "Side gate code is on the key safe.",
  "reportedByName": "Harbourside Dental",
  "reportedByUserId": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
  "assignedToUserId": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
  "assignedToName": "Harbourside Dental",
  "history": [
    {
      "id": "b7e6d5c4-3b2a-4190-8f7e-6d5c4b3a2918",
      "kind": "status",
      "from": "2026-11-06",
      "to": "2026-11-06",
      "byName": "Harbourside Dental",
      "at": "2026-11-06T09:30:00.000Z"
    }
  ],
  "notes": [
    {
      "id": "3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41",
      "body": "Side gate code is on the key safe.",
      "authorName": "Harbourside Dental",
      "mine": false,
      "createdAt": "2026-11-06T09:30:00.000Z"
    }
  ],
  "photos": [
    {
      "id": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
      "width": -9007199254740991,
      "height": -9007199254740991,
      "createdAt": "2026-11-06T09:30:00.000Z",
      "thumbUrl": "https://example.co.uk",
      "fullUrl": "https://example.co.uk"
    }
  ],
  "closedAt": "2026-11-06T09:30:00.000Z",
  "createdAt": "2026-11-06T09:30:00.000Z",
  "updatedAt": "2026-11-06T09:30:00.000Z"
}

An issue photo (thumb or full size)

GET/v1/issues/{id}/photos/{photoId}/{size}

Permission: issue.view
Module: issues
Answers: 200 with a file (image/jpeg)

Parameters

Name	In	Kind
`id`	path	uuidrequired
`photoId`	path	uuidrequired
`size`	path	enumrequired	One of `thumb`, `full`

curl "https://app.workscope.co.uk/v1/issues/ID/photos/ID/SIZE" \
  -H "Authorization: Bearer wsk_your_key_here"

How many issues the caller may see are open and in progress

GET/v1/issues/counts

Permission: issue.view
Module: issues
Answers: 200

Response object

openintegerrequired
-9007199254740991 to 9007199254740991
inProgressintegerrequired
-9007199254740991 to 9007199254740991

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

Example response

{
  "open": -9007199254740991,
  "inProgress": -9007199254740991
}