---
title: "Sync comment threads"
method: GET
path: "/api/v1/collaboration/comment-threads/sync"
tags: ["collaboration"]
---

# Sync comment threads

`GET /api/v1/collaboration/comment-threads/sync`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/collaboration/comment-threads/sync`
- Auth: OAuth 2 (authorization code, authorization URL `https://auth.point11.ai/oauth2/authorize`, token URL `https://auth.point11.ai/oauth2/token`)

Read the signed-in member's comment threads, newest activity first, up to 50 per call with each thread's opening comment and latest replies. Omit `since` for a page: pass the returned `nextPageCursor` as `pageCursor` for older threads. Keep the returned `cursor` and pass it as `since` later to receive only threads changed since then plus the ids of deleted ones; when `hasMoreChanges` is true, call again with the new `cursor` at once. Pass `surfaceId` and `artifactId` together to read one commented page. Needs a signed-in user: read state is per member, so API keys are refused.

## Query parameters

- `since` string: A previous call's `cursor`: return only threads changed since then
- `pageCursor` string: A previous page's `nextPageCursor`: return the next older page
- `surfaceId` string: A commentable page (with artifactId): only its threads
- `artifactId` string, uuid: The campaign or run the commentable page shows (with surfaceId)

## Headers

- `Point11-Organization` string, uuid

## Response `200`

Success.

- CollaborationCommentThreadsSyncResponse
  - `threads` CollaborationThreadsItem[], required
    - `id` string, required
    - `artifactType` string, required
    - `artifactId` string, required
    - `surfaceId` string, required
    - `canonicalHref` string, required: The dashboard path the thread was left on
    - `anchor` union, required
      - object
        - `kind` 'metric_card', required
        - `key` string, required
        - `label` string, required
      - object
        - `kind` 'table_card', required
        - `key` string, required
        - `label` string, required
      - object
        - `kind` 'report_section', required
        - `key` string, required
        - `label` string, required
      - object
        - `kind` 'replay', required
        - `key` 'replay', required
        - `label` string, required
    - `anchorKey` string, required
    - `viewState` object, required
    - `snapshot` object, required: What the anchor showed when the thread was started
      - `version` string, required
      - `title` string, required
      - `subtitle` string, nullable
      - `generatedAt` string, required
      - `values` object[], required
        - `label` string, required
        - `value` string, required
        - `detail` string, nullable
    - `status` 'open' | 'resolved', required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `resolvedAt` string, date-time, nullable, required
    - `creator` object, required
      - `id` string, required
      - `name` string, nullable, required
      - `email` string, required
      - `imageUrl` string, nullable, required
    - `resolvedBy` object, nullable, required
      - `id` string, required
      - `name` string, nullable, required
      - `email` string, required
      - `imageUrl` string, nullable, required
    - `comments` object[], required: The opening comment and the most recent replies, oldest first
      - `id` string, required
      - `parentCommentId` string, nullable, required
      - `body` string, required
      - `createdAt` string, date-time, required
      - `editedAt` string, date-time, nullable, required
      - `author` object, required
        - `id` string, required
        - `name` string, nullable, required
        - `email` string, required
        - `imageUrl` string, nullable, required
      - `mentions` object[], required
        - `id` string, required
        - `name` string, nullable, required
        - `email` string, required
        - `imageUrl` string, nullable, required
      - `invitations` object[], required
        - `invitationId` string, required
        - `email` string, required
        - `status` 'pending' | 'accepted' | 'revoked' | 'expired', required
        - `joined` object, nullable, required: The member the invitation became, once accepted
          - `id` string, required
          - `name` string, nullable, required
          - `email` string, required
          - `imageUrl` string, nullable, required
    - `mentionUserIds` string[], required
    - `unread` boolean, required: Whether the thread changed since the caller last read it
    - `mentionedMe` boolean, required: Whether any comment in the thread mentions the caller
  - `deletedThreadIds` string[], required: Threads deleted since `since`; empty for a page
  - `cursor` string, required: Pass as `since` to read later changes
  - `nextPageCursor` string, nullable, required: Pass as `pageCursor` for older threads; null when none remain
  - `hasMoreChanges` boolean, required: More changes are waiting: call again with `cursor` as `since`

## Other responses

- `400`: The input, query, or Idempotency-Key is invalid.
- `401`: The bearer is missing, expired, or not accepted.
- `403`: The credential lacks the operation's scope or role, or the operation needs a different door.
- `404`: The resource or organization does not exist for this caller.
- `405`: This path takes another HTTP method, named in `Allow`.
- `409`: The request conflicts with current state or with prior use of its Idempotency-Key.
- `413`: The request, or the answer it asks for, is too large; narrow it.
- `429`: The credential's rate budget is spent; retry after `Retry-After` seconds.
- `500`: An unexpected server failure; retry later. Only `request_id` identifies it.
- `503`: A dependency is temporarily unavailable; retry after `Retry-After` seconds.
- `default`: Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.

---

[API](https://skmtc.dev/point11/apis/point11-api.md) · [All operations](https://skmtc.dev/point11/apis/point11-api/llms.txt) · [OpenAPI document](https://skmtc.dev/point11/apis/point11-api/revisions/36a84c7aca11?raw)