collaboration

Sync comment threads

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.

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)

Query parameters

sincestring

A previous call's cursor: return only threads changed since then

pageCursorstring

A previous page's nextPageCursor: return the next older page

surfaceIdstring

A commentable page (with artifactId): only its threads

artifactIdstring uuid

The campaign or run the commentable page shows (with surfaceId)

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Response

Success.

deletedThreadIdsstring[] required

Threads deleted since since; empty for a page

cursorstring required

Pass as since to read later changes

nextPageCursorstring nullable required

Pass as pageCursor for older threads; null when none remain

hasMoreChangesboolean required

More changes are waiting: call again with cursor as since

Changes

No recorded changes to this operation across all 1 revision of this API.