Threads

Threads are the comment pins placed on a markup. Use these endpoints to list, read, create, resolve, reopen, and delete threads, reposition a thread’s pin, and manage the screenshot attached to a thread. Authenticate with an exchange token (embedded feedback) or a workspace- or organization-scoped API key (server-to-server) — see the Authentication overview.

List threads

GET /api/v2/threads

List the threads on a markup. Filter and paginate with the query parameters.

GET /api/v2/threads


curl "https://api.markup.io/api/v2/threads?markupId=4675b9ea-54d6-4b7f-929e-6d142a488897" \
    -X GET \
    -H "Authorization: Bearer <API-KEY-SECRET>" \
    -H "Markup-API-Version: 2023-02-22" \
    -H "Content-Type: application/json"

200 OK


{
  "data": {
    "threads": [
      {}
    ],
    "query": {
      "resolved": true
    },
    "offset": 123,
    "total": 123,
    "cursorId": "some cursorId"
  }
}

Response Body ProjectThreadsResponse

Option	Type
threads	ThreadResponse[]
query	IProjectThreadQuery
offset	number
total	number
cursorId	string

Request Query Params ListThreadsQuery

Option	Type
markupId	string
cursorId optional	string
limit optional	number
withThreadOrMessageId optional	string
resolved optional	boolean
order optional	ThreadOrder
viewMode optional	ViewModeCategory
q optional	string
offset optional	number

Get thread

GET /api/v2/threads/:id

Get a single thread by ID, including its messages.

GET /api/v2/threads/:id


curl "https://api.markup.io/api/v2/threads/69a3ea9c-d31c-494f-9548-73365b277396" \
    -X GET \
    -H "Authorization: Bearer <API-KEY-SECRET>" \
    -H "Markup-API-Version: 2023-02-22" \
    -H "Content-Type: application/json"

200 OK


{
  "data": {
    "id": "some id",
    "createdAt": {},
    "modifiedAt": {},
    "scopes": [
      "some string"
    ],
    "assignedRoleSlugs": [
      "some string"
    ],
    "user": {
      "id": "some id",
      "createdAt": {},
      "modifiedAt": {},
      "name": "some name",
      "guest": true
    },
    "number": 123,
    "resolved": true,
    "messages": [
      {
        "id": "some id",
        "createdAt": {},
        "modifiedAt": {},
        "scopes": [
          "some string"
        ],
        "assignedRoleSlugs": [
          "some string"
        ],
        "threadId": "some threadId",
        "message": "some message",
        "messageJson": {},
        "user": {
          "id": "some id",
          "createdAt": {},
          "modifiedAt": {},
          "name": "some name",
          "guest": true
        },
        "userMetaData": {},
        "attachments": [
          {
            "id": "some id",
            "createdAt": {},
            "modifiedAt": {},
            "messageId": "some messageId",
            "url": "some url",
            "etag": "some etag",
            "mimeType": "some mimeType",
            "originalFilename": "some originalFilename",
            "filesize": 123
          }
        ],
        "loomVideos": [
          {
            "id": "some id",
            "createdAt": {},
            "modifiedAt": {},
            "messageId": "some messageId",
            "title": "some title",
            "sharedUrl": "some sharedUrl",
            "width": 123,
            "height": 123
          }
        ]
      }
    ],
    "userMetaData": {},
    "projectId": "some projectId",
    "proxyUrl": "some proxyUrl",
    "originalUrl": "some originalUrl",
    "canonicalUrl": "some canonicalUrl",
    "elements": [
      {
        "id": "some id",
        "createdAt": {},
        "modifiedAt": {},
        "threadId": "some threadId",
        "path": "some path",
        "offsetXPercentage": 123,
        "offsetYPercentage": 123
      }
    ],
    "parents": [
      {
        "id": "some id",
        "createdAt": {},
        "modifiedAt": {},
        "path": "some path",
        "depth": 123,
        "proxyUrl": "some proxyUrl",
        "originalUrl": "some originalUrl",
        "canonicalUrl": "some canonicalUrl"
      }
    ],
    "viewModeId": "some viewModeId"
  }
}

Response Body - ThreadResponse

Request Path Params IdRequestParam

Option	Type
id	string

Create thread

POST /api/v2/threads

Create a new thread (comment pin) on a markup.

POST /api/v2/threads


curl "https://api.markup.io/api/v2/threads" \
    -X POST \
    -H "Authorization: Bearer <API-KEY-SECRET>" \
    -H "Markup-API-Version: 2023-02-22" \
    -H "Content-Type: application/json" \
	--data '{
    "isImageThread": true,
    "url": "some url",
    "canonicalUrl": "some canonicalUrl",
    "elements": [
        {
            "elementPath": "some elementPath",
            "offsetXPercentage": 123,
            "offsetYPercentage": 123
        }
    ],
    "offsetXPercentage": 123,
    "offsetYPercentage": 123,
    "message": {},
    "browserContext": {},
    "elementParents": [
        {
            "url": "some url",
            "canonicalUrl": "some canonicalUrl",
            "path": "some path",
            "depth": 123
        }
    ],
    "viewModeId": "6b1589e9-6cf9-46fe-abc8-e2025d575dad"
}'

200 OK


{
  "data": {
    "id": "some id",
    "createdAt": {},
    "modifiedAt": {},
    "scopes": [
      "some string"
    ],
    "assignedRoleSlugs": [
      "some string"
    ],
    "user": {
      "id": "some id",
      "createdAt": {},
      "modifiedAt": {},
      "name": "some name",
      "guest": true
    },
    "number": 123,
    "resolved": true,
    "messages": [
      {
        "id": "some id",
        "createdAt": {},
        "modifiedAt": {},
        "scopes": [
          "some string"
        ],
        "assignedRoleSlugs": [
          "some string"
        ],
        "threadId": "some threadId",
        "message": "some message",
        "messageJson": {},
        "user": {
          "id": "some id",
          "createdAt": {},
          "modifiedAt": {},
          "name": "some name",
          "guest": true
        },
        "userMetaData": {},
        "attachments": [
          {
            "id": "some id",
            "createdAt": {},
            "modifiedAt": {},
            "messageId": "some messageId",
            "url": "some url",
            "etag": "some etag",
            "mimeType": "some mimeType",
            "originalFilename": "some originalFilename",
            "filesize": 123
          }
        ],
        "loomVideos": [
          {
            "id": "some id",
            "createdAt": {},
            "modifiedAt": {},
            "messageId": "some messageId",
            "title": "some title",
            "sharedUrl": "some sharedUrl",
            "width": 123,
            "height": 123
          }
        ]
      }
    ],
    "userMetaData": {},
    "projectId": "some projectId",
    "proxyUrl": "some proxyUrl",
    "originalUrl": "some originalUrl",
    "canonicalUrl": "some canonicalUrl",
    "elements": [
      {
        "id": "some id",
        "createdAt": {},
        "modifiedAt": {},
        "threadId": "some threadId",
        "path": "some path",
        "offsetXPercentage": 123,
        "offsetYPercentage": 123
      }
    ],
    "parents": [
      {
        "id": "some id",
        "createdAt": {},
        "modifiedAt": {},
        "path": "some path",
        "depth": 123,
        "proxyUrl": "some proxyUrl",
        "originalUrl": "some originalUrl",
        "canonicalUrl": "some canonicalUrl"
      }
    ],
    "viewModeId": "some viewModeId"
  }
}

Response Body - ThreadResponse

Request Body CreateThreadRequest

Option	Type
isImageThread	boolean
projectId optional	string
projectImageId optional	string
url	string
canonicalUrl	string
elements	CreateThreadRequestElement[]
offsetXPercentage	number
offsetYPercentage	number
startTime optional	number
endTime optional	number
message	Delta
browserContext	BrowserContextRequest
elementParents	ThreadElementParentRequest[]
viewModeId	string
attachments optional	MessageRequestAttachment[]
loomVideos optional	LoomVideoRequest[]
width optional	number
height optional	number
annotations optional	CanvasThreadAnnotationRequest
textHighlight optional	ThreadTextHighlightRequest
pageNumber optional	number
requireDimensionsOverride optional	boolean
priority optional	number

Resolve thread

POST /api/v2/threads/:id/resolve

Mark a thread as resolved.

POST /api/v2/threads/:id/resolve


curl "https://api.markup.io/api/v2/threads/d00ab066-7e22-4ad7-8ab4-8fd26ca58d9a/resolve" \
    -X POST \
    -H "Authorization: Bearer <API-KEY-SECRET>" \
    -H "Markup-API-Version: 2023-02-22" \
    -H "Content-Type: application/json"

200 OK


{
  "data": {
    "threadId": "some threadId",
    "modifiedAt": 123
  }
}

Response Body ThreadResolvedResponse

Option	Type
threadId	string
modifiedAt	number

Request Path Params IdRequestParam

Option	Type
id	string

Unresolve thread

POST /api/v2/threads/:id/unresolve

Reopen a previously resolved thread.

POST /api/v2/threads/:id/unresolve


curl "https://api.markup.io/api/v2/threads/c2ab17f1-6f18-4a3d-a53b-c103d62098ab/unresolve" \
    -X POST \
    -H "Authorization: Bearer <API-KEY-SECRET>" \
    -H "Markup-API-Version: 2023-02-22" \
    -H "Content-Type: application/json"

200 OK


{
  "data": {
    "threadId": "some threadId"
  }
}

Response Body ThreadUnresolvedResponse

Option	Type
threadId	string

Request Path Params IdRequestParam

Option	Type
id	string

Delete thread

DELETE /api/v2/threads/:id

Delete a thread and all of its messages.

DELETE /api/v2/threads/:id


curl "https://api.markup.io/api/v2/threads/0b03f4bd-c31b-441a-b89f-d67283a7c576" \
    -X DELETE \
    -H "Authorization: Bearer <API-KEY-SECRET>" \
    -H "Markup-API-Version: 2023-02-22" \
    -H "Content-Type: application/json"

Response


204 No Content

Request Path Params IdRequestParam

Option	Type
id	string

Move thread pin

PATCH /api/v2/threads/:id/move-pin

Reposition a thread’s pin on the markup.

PATCH /api/v2/threads/:id/move-pin


curl "https://api.markup.io/api/v2/threads/7ae744be-77d7-4354-bbcc-7707986d35e2/move-pin" \
    -X PATCH \
    -H "Authorization: Bearer <API-KEY-SECRET>" \
    -H "Markup-API-Version: 2023-02-22" \
    -H "Content-Type: application/json" \
	--data '{
    "url": "some url",
    "canonicalUrl": "some canonicalUrl",
    "elements": [
        {
            "elementPath": "some elementPath",
            "offsetXPercentage": 123,
            "offsetYPercentage": 123
        }
    ],
    "browserContext": {},
    "elementParents": [
        {
            "url": "some url",
            "canonicalUrl": "some canonicalUrl",
            "path": "some path",
            "depth": 123
        }
    ],
    "viewportXPercentage": 123,
    "viewportYPercentage": 123
}'

200 OK


{
  "data": {
    "id": "some id",
    "userId": "some userId",
    "projectId": "some projectId",
    "number": 123,
    "resolved": true,
    "proxyHostId": "some proxyHostId",
    "urlPath": "some urlPath",
    "canonicalUrl": "some canonicalUrl",
    "viewModeId": "some viewModeId"
  }
}

Response Body - Thread

Request Path Params IdRequestParam

Option	Type
id	string

Request Body MoveThreadPinBody

Option	Type
url	string
canonicalUrl	string
elements	CreateThreadRequestElement[]
browserContext	BrowserContextRequest
elementParents	ThreadElementParentRequest[]
viewportXPercentage	number
viewportYPercentage	number

Get screenshot upload policy

GET /api/v2/threads/:id/screenshot-upload-policy

Get a pre-signed S3 upload policy for attaching a screenshot to a thread. Upload the file to S3 with the returned policy, then call PUT /threads/:id/screenshot to attach it.

GET /api/v2/threads/:id/screenshot-upload-policy


curl "https://api.markup.io/api/v2/threads/2f2f26a3-0885-4f12-a352-332bb1f0402e/screenshot-upload-policy?fileId=ef80c8ba-6ed3-492b-8579-7c8c472a0907&filesize=123&filename=some+filename&mimeType=some+mimeType" \
    -X GET \
    -H "Authorization: Bearer <API-KEY-SECRET>" \
    -H "Markup-API-Version: 2023-02-22" \
    -H "Content-Type: application/json"

200 OK


{
  "data": {
    "key": "some key",
    "policy": {},
    "bucket": "some bucket"
  }
}

Response Body S3UploadPolicyResponse

Option	Type
key	string
policy	PresignedPost
bucket	string
metadata	Record

Request Path Params IdRequestParam

Option	Type
id	string

Request Query Params ScreenshotUploadPolicyRequestQuery

Option	Type
fileId	string
filesize	number
filename	string
mimeType	string

Set thread screenshot

PUT /api/v2/threads/:id/screenshot

Attach (or replace) the screenshot for a thread after uploading the file with the upload policy.

PUT /api/v2/threads/:id/screenshot


curl "https://api.markup.io/api/v2/threads/985a1b5e-86c9-4f60-9111-3657c159afc6/screenshot" \
    -X PUT \
    -H "Authorization: Bearer <API-KEY-SECRET>" \
    -H "Markup-API-Version: 2023-02-22" \
    -H "Content-Type: application/json" \
	--data '{
    "key": "some key",
    "etag": "some etag",
    "mimeType": "some mimeType",
    "width": 123,
    "height": 123,
    "filesize": 123,
    "fileId": "9212de7c-776c-4ac3-b26d-b55d2cb54d70"
}'

200 OK


{
  "data": {
    "id": "some id",
    "createdAt": {},
    "modifiedAt": {},
    "mimeType": "some mimeType",
    "width": 123,
    "height": 123,
    "filesize": 123,
    "type": "extension",
    "isProcessing": true
  }
}

Response Body - ScreenshotResponse

Request Path Params IdRequestParam

Option	Type
id	string

Request Body CreateScreenshotRequest

Option	Type
key	string
etag	string
mimeType	string
width	number
height	number
filesize	number
originalFilename optional	string
fileId	string

Get thread screenshot

GET /api/v2/threads/:id/screenshot

Get the screenshot attached to a thread.

GET /api/v2/threads/:id/screenshot


curl "https://api.markup.io/api/v2/threads/b2ed9639-d6b6-4ccb-8275-07d64014f345/screenshot" \
    -X GET \
    -H "Authorization: Bearer <API-KEY-SECRET>" \
    -H "Markup-API-Version: 2023-02-22" \
    -H "Content-Type: application/json"

200 OK


{
  "data": {
    "id": "some id",
    "createdAt": {},
    "modifiedAt": {},
    "mimeType": "some mimeType",
    "width": 123,
    "height": 123,
    "filesize": 123,
    "type": "extension",
    "isProcessing": true
  }
}

Response Body - ScreenshotResponse

Request Path Params IdRequestParam

Option	Type
id	string

`ScreenshotResponse`

Option	Type
id	string
createdAt	Unix_Timestamp_Utc_Milliseconds
modifiedAt	Unix_Timestamp_Utc_Milliseconds
mimeType	string
width	number
height	number
filesize	number
type	ScreenshotType
isProcessing	boolean

`ThreadOrder`

Option	Type
ThreadOrder	`page` \| `pin_asc` \| `pin_desc` \| `activity` \| `timestamp` \| `priority_asc` \| `priority_desc`

`ViewModeCategory`

Option	Type
ViewModeCategory	`desktop` \| `tablet` \| `mobile`

`ThreadElementParentRequest`

Option	Type
url	string
canonicalUrl	string
path	string
depth	number

`BrowserContextRequest`

Option	Type
browserName	string
browserVersion	string
os	string
osVersion	string
osVersionName	string
platform	string
screenWidth	number
screenHeight	number
viewportWidth	number
viewportHeight	number

`CanvasThreadAnnotationRequest`

Option	Type
version	string
scale	number
originalWidth	number
originalHeight	number

`ThreadTextHighlightRequest`

Option	Type
startKey	string
endKey	string
startOffset	number
startIndex	number
endOffset	number
endIndex	number
text	string

`IProjectThreadQuery`

Option	Type
resolved	boolean

`ThreadResponse`

Option	Type
ThreadResponse	WebpageThreadResponse \| ImageThreadResponse \| PdfThreadResponse

`WebpageThreadResponse`

Option	Type
id	string
createdAt	Unix_Timestamp_Utc_Milliseconds
modifiedAt	Unix_Timestamp_Utc_Milliseconds
scopes	string[]
assignedRoleSlugs	string[]
user	AuthorUserResponse
number	number
resolved	boolean
messages	MessageResponse[]
userMetaData	IUserResourceMetaData
lastActivityAt	number
annotations	AnnotationsResponse
projectId	string
proxyUrl	string
originalUrl	string
canonicalUrl	string
elements	ThreadElementResponse[]
parents	ThreadElementParentResponse[]
browserContext	IBrowserContext
viewModeId	string

`ImageThreadResponse`

Option	Type
id	string
createdAt	Unix_Timestamp_Utc_Milliseconds
modifiedAt	Unix_Timestamp_Utc_Milliseconds
scopes	string[]
assignedRoleSlugs	string[]
user	AuthorUserResponse
number	number
resolved	boolean
messages	MessageResponse[]
userMetaData	IUserResourceMetaData
lastActivityAt	number
annotations	AnnotationsResponse
projectImageId	string
offsetXPercentage	number
offsetYPercentage	number
startTime	number
endTime	number

`PdfThreadResponse`

Option	Type
id	string
createdAt	Unix_Timestamp_Utc_Milliseconds
modifiedAt	Unix_Timestamp_Utc_Milliseconds
scopes	string[]
assignedRoleSlugs	string[]
user	AuthorUserResponse
number	number
resolved	boolean
messages	MessageResponse[]
userMetaData	IUserResourceMetaData
lastActivityAt	number
annotations	AnnotationsResponse
projectImageId	string
offsetXPercentage	number
offsetYPercentage	number
pageNumber	number
textHighlight	TextHighlightResponse

`Thread`

Option	Type
Thread	WebpageThread \| ImageThread \| PdfThread

`WebpageThread`

Option	Type
id	string
userId	string
projectId	string
number	number
resolved	boolean
proxyHostId	string
urlPath	string
canonicalUrl	string
viewModeId	string

`ImageThread`

Option	Type
id	string
userId	string
projectId	string
number	number
resolved	boolean
projectImageId	string
offsetXPercentage	number
offsetYPercentage	number
startTime	number
endTime	number

`PdfThread`

Option	Type
id	string
userId	string
projectId	string
number	number
resolved	boolean
pageNumber	number
pageRelativeX	number
pageRelativeY	number

`ScreenshotType`

Option	Type
ScreenshotType	`extension` \| `native` \| `static`

Threads

List threads

Get thread

Create thread

Resolve thread

Unresolve thread

Delete thread

Move thread pin

Get screenshot upload policy

Set thread screenshot

Get thread screenshot

Related types

ScreenshotResponse

ThreadOrder

ViewModeCategory

ThreadElementParentRequest

BrowserContextRequest

CanvasThreadAnnotationRequest

ThreadTextHighlightRequest

IProjectThreadQuery

ThreadResponse

WebpageThreadResponse

ImageThreadResponse

PdfThreadResponse

Thread

WebpageThread

ImageThread

PdfThread

ScreenshotType

`ScreenshotResponse`

`ThreadOrder`

`ViewModeCategory`

`ThreadElementParentRequest`

`BrowserContextRequest`

`CanvasThreadAnnotationRequest`

`ThreadTextHighlightRequest`

`IProjectThreadQuery`

`ThreadResponse`

`WebpageThreadResponse`

`ImageThreadResponse`

`PdfThreadResponse`

`Thread`

`WebpageThread`

`ImageThread`

`PdfThread`

`ScreenshotType`