Models
API Request Objects
Models
API Request Objects
Comments
Threads
AddCommentAnnotationRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotation | CommentAnnotation | Yes | Comment annotation |
options | RequestOptions | No | Request options |
DeleteCommentAnnotationRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
CommentRequestQuery
| Property | Type | Required | Description |
|---|---|---|---|
documentIds | string[] | Yes | Array of document IDs to query |
locationIds | string[] | No | Array of location IDs to filter by |
statusIds | string[] | No | Array of status IDs to filter by |
GetCommentAnnotationsCountResponse
| Property | Type | Required | Description |
|---|---|---|---|
data | Record<string, CommentAnnotationsCount> | null | Yes | Map of document IDs to their comment counts. Null while loading |
GetCommentAnnotationsResponse
| Property | Type | Required | Description |
|---|---|---|---|
data | Record<string, CommentAnnotation[]> | null | Yes | Map of document IDs to their annotations. Null while loading |
FetchCommentAnnotationsRequest
| Property | Type | Required | Description |
|---|---|---|---|
createdAfter | number | No | Filter annotations created after this timestamp |
createdBefore | number | No | Filter annotations created before this timestamp |
updatedAfter | number | No | Filter annotations updated after this timestamp |
updatedBefore | number | No | Filter annotations updated before this timestamp |
statusIds | string[] | No | Filter annotations by status IDs |
order | 'asc' | 'desc' | No | Sort order for annotations |
pageToken | string | No | Token for fetching next page of results |
allDocuments | boolean | No | Whether to fetch annotations from all documents |
pageSize | number | No | Number of results per page |
organizationId | string | No | Organization ID to fetch annotations from |
locationId | string | No | Location ID to filter annotations by |
documentIds | string[] | No | Array of specific document IDs to fetch from |
folderId | string | No | Folder ID to fetch annotations from |
resolvedBy | string | No | Filter comments by user who resolved the comment |
userIds | string[] | No | Filter comments by comment annotation author |
mentionedUserIds | string[] | No | Filter comments where provided users are tagged in the comment |
FetchCommentAnnotationsResponse
| Property | Type | Required | Description |
|---|---|---|---|
data | Record<string, CommentAnnotation[]> | null | Yes | Map of document IDs to their annotations. Null while loading |
nextPageToken | string | Yes | Token for fetching next page of results |
GetCommentResolverRequest
| Property | Type | Required | Description |
|---|---|---|---|
organizationId | string | Yes | Organization ID to fetch comments from |
commentAnnotationIds | string[] | No | Array of comment annotation IDs to fetch comments from |
documentIds | string[] | No | Array of document IDs to fetch comments from |
folderId | string | No | Folder ID to fetch comments from |
allDocuments | boolean | No | Whether to fetch comments from all documents within the given folder |
SaveCommentResolverRequest
| Property | Type | Required | Description |
|---|---|---|---|
commentAnnotation | { [key: string]: PartialCommentAnnotation } | Yes | Map of comment annotation data to save |
event | ResolverActions | No | Event name that caused the save request |
commentId | string | No | ID of the comment to save |
DeleteCommentResolverRequest
| Property | Type | Required | Description |
|---|---|---|---|
commentAnnotationId | string | Yes | ID of the comment annotation to delete |
metadata | BaseMetadata | No | Additional metadata for the request |
event | ResolverActions | No | Event name that caused the delete request |
Messages
AddCommentRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
comment | Comment | Yes | Comment object |
assignedTo | User | No | Assigned user |
options | RequestOptions | No | Request options |
UpdateCommentRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
comment | Comment | Yes | Comment object |
merge | boolean | No | Merge comments |
options | RequestOptions | No | Request options |
DeleteCommentRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
skipDeleteThreadConfirmation | boolean | No | Skip delete confirmation |
options | RequestOptions | No | Request options |
GetCommentRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
@Mentions
AssignUserRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
assignedTo | UserContact | Yes | User to assign |
options | RequestOptions | No | Request options |
GetContactListResponse
| Property | Type | Required | Description |
|---|---|---|---|
organizationUsers | User[] | No | List of users in the organization |
folderUsers | User[] | No | List of users added to the folder |
documentUsers | User[] | No | List of users added to the document |
userGroups | UserGroup[] | No | List of user groups in the organization |
updatedContactList | User[] | No | List of contacts updated via updateContactList API |
SubscribeCommentAnnotationRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
UnsubscribeCommentAnnotationRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
Attachments
AddAttachmentRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
files | File[] | Yes | Array of files |
options | RequestOptions | No | Request options |
DeleteAttachmentRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
attachmentId | number | Yes | ID of the attachment |
options | RequestOptions | No | Request options |
GetAttachmentRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
options | RequestOptions | No | Request options |
AddAttachmentResponse
| Property | Type | Required | Description |
|---|---|---|---|
valid | boolean | Yes | Validity status |
file | File | No | File object |
maxAllowedSize | number | Yes | Max allowed size |
error | string | No | Error message |
attachment | Attachment | No | Attachment object |
Reactions
AddReactionRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
reaction | { reactionId: string; customReaction?: ReactionItem; } | Yes | Reaction object with reactionId and optional customReaction |
options | RequestOptions | No | Request options |
DeleteReactionRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
reaction | { reactionId: string; customReaction?: ReactionItem; } | Yes | Reaction object with reactionId and optional customReaction |
options | RequestOptions | No | Request options |
ToggleReactionRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
reaction | { reactionId: string; customReaction?: ReactionItem; } | Yes | Reaction object with reactionId and optional customReaction |
options | RequestOptions | No | Request options |
ReactionItem
| Property | Type | Required | Description |
|---|---|---|---|
url | string | No | URL of the reaction image |
emoji | string | No | Emoji character |
GetReactionResolverRequest
| Property | Type | Required | Description |
|---|---|---|---|
organizationId | string | Yes | ID of the organization to fetch reactions from |
reactionAnnotationIds | string[] | No | Array of reaction annotation IDs to fetch reactions from |
documentIds | string[] | No | Array of document IDs to fetch reactions from |
folderId | string | No | ID of the folder to fetch reactions from |
allDocuments | boolean | No | Whether to get reactions from all documents within the given folder |
SaveReactionResolverRequest
| Property | Type | Required | Description |
|---|---|---|---|
reactionAnnotation | { [key: string]: PartialReactionAnnotation } | Yes | Map of reaction annotation id to reaction annotation data |
event | ResolverActions | No | Event name that caused the save request |
DeleteReactionResolverRequest
| Property | Type | Required | Description |
|---|---|---|---|
reactionAnnotationId | string | Yes | ID of the reaction annotation |
metadata | BaseMetadata | No | Base metadata |
event | ResolverActions | No | Event name that caused the delete request |
Status & Priority
UpdateStatusRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
status | CustomStatus | Yes | Status value |
options | RequestOptions | No | Request options |
ResolveCommentAnnotationRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
UpdatePriorityRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
priority | CustomPriority | No | Priority object |
options | RequestOptions | No | Request options |
ApproveCommentAnnotationRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
AcceptCommentAnnotationRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
RejectCommentAnnotationRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
Recordings
GetRecordingRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
options | RequestOptions | No | Request options |
DeleteRecordingRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
recorderId | string | Yes | ID of the recorder |
options | RequestOptions | No | Request options |
Deep Links
GetLinkRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
CopyLinkRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
Access
UpdateAccessRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
accessMode | CommentAccessMode | Yes | Access mode |
options | RequestOptions | No | Request options |
RequestOptions
| Property | Type | Required | Description |
|---|---|---|---|
documentId | string | No | Document ID |
Recorder
Recorder Data
RecorderRequestQuery
| Property | Type | Required | Description |
|---|---|---|---|
recorderIds | string[] | Yes | Array of recorder IDs to query |
GetRecordingDataResponse
| Property | Type | Required | Description |
|---|---|---|---|
recorderId | string | Yes | ID of the recorder |
metadata | RecorderMetadata | No | Metadata for the recording |
assets | RecorderDataAsset[] | Yes | Array of recording assets |
transcription | RecorderDataTranscription | Yes | Transcription data for the recording |
Client
Folders
FetchFoldersRequest
| Property | Type | Required | Description |
|---|---|---|---|
organizationId | string | Yes | Organization ID to fetch folders from |
folderId | string | No | Parent folder ID to fetch child folders from |
FetchFoldersResponse
| Property | Type | Required | Description |
|---|---|---|---|
data | Record<string, FolderMetadata> | null | Yes | Map of folder IDs to their metadata. Null while loading |
nextPageToken | string | Yes | Token for fetching next page of results |
Documents
SetDocumentsRequestOptions
| Property | Type | Required | Description |
|---|---|---|---|
organizationId | string | No | Organization ID for the documents |
folderId | string | No | Subscribe to all or provided documents in the given folder |
locationId | string | No | Filter and subscribe to document data for a specific location |
allDocuments | boolean | No | Subscribe to all documents in the folder. Use this when folderId is provided |
FetchDocumentsRequest
| Property | Type | Required | Description |
|---|---|---|---|
organizationId | string | Yes | Organization ID to fetch documents from |
documentIds | string[] | No | Array of specific document IDs to fetch |
folderId | string | No | Folder ID to fetch documents from |
allDocuments | boolean | No | Whether to fetch all documents from folder |
FetchDocumentsResponse
| Property | Type | Required | Description |
|---|---|---|---|
data | Record<string, DocumentMetadata> | null | Yes | Map of document IDs to their metadata. Null while loading |
nextPageToken | string | Yes | Token for fetching next page of results. Default page size is 1000. |
Was this page helpful?