Records

Get all records

get
Responses
chevron-right
200

Success

application/json
messagenullRequired

Message

Example: Message
ownerstringRequired

Owner UUID

Example: <uuid>
updatedAtstringRequired

Updated at timestamp

Example: 2024-01-04T06:39:58.231Z
whitelistedGroupsnullRequired

Whitelisted groups

Example: example
lastMessagenullRequired

Last message

Example: Last
versionCountintegerRequired

Version count

Example: 1
prioritystringRequired

Priority

Example: normal
statusTitlestringRequired

Status title

Example: Pending
privacystringRequired

Privacy

Example: none
agenumberRequired

Age

Example: 24.9
createdAtstringRequired

Created at timestamp

Example: 2024-01-04T06:39:58.141Z
membersstring[]Required

List of members in the chatroom

Example: ["<uuid1>","<uuid2>"]
parentnullRequired

Parent

Example: parent
whitelistnullRequired

Whitelist

idintegerRequired

ID

Example: 181
privacySettingsnullRequired

Privacy settings

Example: settings
countintegerRequired

Count

Example: 0
completedAtnullRequired

Completed at timestamp

Example: <TIME>
originSeqNointegerRequired

Origin sequence number

Example: 46
creatorstringRequired

Creator UUID

Example: <uuid>
originChatroomIdintegerRequired

Origin chatroom ID

Example: 11
remindersnullRequired

Reminders

currentVersionbooleanRequired

Current version

Example: true
autoNostringRequired

Auto number

Example: 46
archivednullRequired

Archived

Example: true
seqNointegerRequired

Sequence number

Example: 46
addressstringRequired

Address

Example: 75E4R6EQM
derivedTitlestringRequired

Derived title

Example: Approval Test #46: title
statusintegerRequired

Status

Example: -1
processWhitelistGroupsnullRequired

Process whitelist groups

Example: example
versionCommentnullRequired

Version comment

Example: example
lastMessageAuthorstringRequired

Last message author

Example: unibot
processTitlestringRequired

Process title

Example: Approval Test
titlestringRequired

Title

Example: TItle
typestringRequired

Type

Example: workflow
childCountintegerRequired

Child count

Example: 0
versionintegerRequired

Version

Example: 1
metanullRequired

Meta

Example: example
completedBynullRequired

Completed by

Example: <uuid>
memberCountintegerRequired

Member count

Example: 1
dueDatenullRequired

Due date

activebooleanRequired

Active

Example: true
templateIdintegerRequired

Template ID

Example: 33
outcomenullRequired

Outcome

Example: example
breadcrumbsnullRequired

Breadcrumbs

Example: example
orgIdintegerRequired

Organization ID

Example: 1
processWhitelistnullRequired

Process whitelist

Example: example
descriptionstringRequired

Description

Example: description
cancelednullRequired

Canceled

Example: false
get
/chatroom

Get record

get
Path parameters
idintegerRequired

ID of the chatroom

Example: 12
Responses
chevron-right
200

Success

application/json
messagenullRequired

Message

Example: Message
ownerstringRequired

Owner UUID

Example: <uuid>
updatedAtstringRequired

Updated at timestamp

Example: 2024-01-04T06:39:58.231Z
whitelistedGroupsnullRequired

Whitelisted groups

Example: example
lastMessagenullRequired

Last message

Example: Last
versionCountintegerRequired

Version count

Example: 1
prioritystringRequired

Priority

Example: normal
statusTitlestringRequired

Status title

Example: Pending
privacystringRequired

Privacy

Example: none
agenumberRequired

Age

Example: 24.9
createdAtstringRequired

Created at timestamp

Example: 2024-01-04T06:39:58.141Z
membersstring[]Required

List of members in the chatroom

Example: ["<uuid1>","<uuid2>"]
parentnullRequired

Parent

Example: parent
whitelistnullRequired

Whitelist

idintegerRequired

ID

Example: 181
privacySettingsnullRequired

Privacy settings

Example: settings
countintegerRequired

Count

Example: 0
completedAtnullRequired

Completed at timestamp

Example: <TIME>
originSeqNointegerRequired

Origin sequence number

Example: 46
creatorstringRequired

Creator UUID

Example: <uuid>
originChatroomIdintegerRequired

Origin chatroom ID

Example: 11
remindersnullRequired

Reminders

currentVersionbooleanRequired

Current version

Example: true
autoNostringRequired

Auto number

Example: 46
archivednullRequired

Archived

Example: true
seqNointegerRequired

Sequence number

Example: 46
addressstringRequired

Address

Example: 75E4R6EQM
derivedTitlestringRequired

Derived title

Example: Approval Test #46: title
statusintegerRequired

Status

Example: -1
processWhitelistGroupsnullRequired

Process whitelist groups

Example: example
versionCommentnullRequired

Version comment

Example: example
lastMessageAuthorstringRequired

Last message author

Example: unibot
processTitlestringRequired

Process title

Example: Approval Test
titlestringRequired

Title

Example: TItle
typestringRequired

Type

Example: workflow
childCountintegerRequired

Child count

Example: 0
versionintegerRequired

Version

Example: 1
metanullRequired

Meta

Example: example
completedBynullRequired

Completed by

Example: <uuid>
memberCountintegerRequired

Member count

Example: 1
dueDatenullRequired

Due date

activebooleanRequired

Active

Example: true
templateIdintegerRequired

Template ID

Example: 33
outcomenullRequired

Outcome

Example: example
breadcrumbsnullRequired

Breadcrumbs

Example: example
orgIdintegerRequired

Organization ID

Example: 1
processWhitelistnullRequired

Process whitelist

Example: example
descriptionstringRequired

Description

Example: description
cancelednullRequired

Canceled

Example: false
get
/chatroom/{id}

Create record

post
Body
titlestringOptional

Title

Example: Purchase
typestringOptional

Type

Example: workflow
ownerstringOptional

User ID of the owner

Example: Q79THCOJ5CcvWRMPeIVZiq1ezu42
membersstring[]Optional

List of user IDs

Example: ["Q79THCOJ5CcvWRMPeIVZiq1ezu42"]
groupsinteger[]Optional

List of group IDs

Example: [26]
templateIdintegerRequired

ID of the process

Example: 33
descriptionstringOptional

Description

Example: For purchase order
privacystringOptional

Privacy

Example: none
Responses
chevron-right
200

Success

application/json
messagestringRequired

Message

Example: Message
updatedAtstringRequired

Date and time when the record was last updated

Example: 2024-02-02T04:29:09.335Z
whitelistedGroupsstring[]Required

List of whitelisted groups

Example: ["Group1","Group2"]
lastMessagestringRequired

Last message content

Example: Completed
versionCountintegerRequired

Version count

Example: 1
prioritystringRequired

Priority level

Example: normal
statusTitlestringRequired

Status title

Example: Pending
privacystringRequired

Privacy setting

Example: none
agenumberRequired

Age value

Example: 0
createdAtstringRequired

Date and time when the record was created

Example: 2024-02-02T04:29:09.182Z
parentintegerRequired

Parent ID

Example: 11
whiteliststring[]Required

List of whitelisted entities

Example: ["UID1","UID2"]
idintegerRequired

ID

Example: 208
privacySettingsobjectRequired

Privacy settings

countintegerRequired

Count value

Example: 0
completedAtstringRequired

Date and time when the chatroom was completed

Example: 2024-02-02T04:17:21.859Z
originSeqNointegerRequired

Origin sequence number

Example: 61
creatorstringRequired

Creator ID

Example: Q79THCOJ5CcvWRMPeIVZiq1ezu42
originChatroomIdintegerRequired

Origin chatroom ID

Example: 11
remindersobjectRequired

Reminders information

currentVersionbooleanRequired

Flag indicating if it is the current version

Example: true
autoNostringRequired

Auto number

Example: 61
archivedbooleanRequired

Flag indicating if the chatroom is archived

Example: false
seqNointegerRequired

Sequence number

Example: 61
addressstringRequired

Address

Example: Y1GW0PGZK
derivedTitlestringRequired

Derived title

Example: Approval Test #61: New-chatroom
statusintegerRequired

Status

Example: -1
processWhitelistGroupsstring[]Required

List of process whitelist groups

versionCommentstringRequired

Version comment

Example: Comment
lastMessageAuthorstringRequired

Last message author

Example: unibot
processTitlestringRequired

Process title

Example: Approval Test
titlestringRequired

Title

Example: New-chatroom
typestringRequired

Type

Example: workflow
childCountintegerRequired

Child count value

Example: 0
processOwnersstring[]Required

List of process owners

versionintegerRequired

Version value

Example: 1
metastringRequired

Meta information

Example: Meta Information
completedBystringRequired

Completed by information

Example: UID
memberCountintegerRequired

Member count value

Example: 2
dueDatestringRequired

Due date

Example: 2023-01-22
activebooleanRequired

Flag indicating if the chatroom is active

Example: true
groupMembersobjectRequired

Group members information

templateIdintegerRequired

Template ID

Example: 33
outcomestringRequired

List of outcome entities

breadcrumbsstringRequired

List of breadcrumb entities

groupsstring[]Required

List of group IDs

orgIdintegerRequired

Organization ID

Example: 1
processWhiteliststring[]Required

List of process whitelist entities

descriptionstringRequired

Description

canceledbooleanRequired

Flag indicating if the record is canceled

Example: false
post
/chatroom

Update record

patch
Path parameters
idintegerRequired

ID

Example: 12
Body
titlestringOptional

Title

Example: Andromeda
due-datestringOptional

Due date as an ISO timestamp

Example: 2025-02-27T18:30:00.000Z
ownerstringOptional

User ID

Example: Q79THCOJWRMPeIVZiq1e42
descriptionstringOptional

Description

Example: abc
parentintegerOptional

Parent ID

Example: 10
prioritystringOptional

Priority

Example: high
privacystringOptional

Privacy

Example: content
statusintegerOptional

Status ID

Example: -2
commentstringOptional

Additional comment (used when updating the status)

Example: Completed
archivedbooleanOptional

Archive record

Example: true
remindersbooleanOptional

Toggle reminders

Example: true
unreadbooleanOptional

Clear unread count for user (use false to clear)

Example: false
currentVersionbooleanOptional

Mark as current revision

Example: true
versionCommentstringOptional

Adds comment when marking as current

Example: This is the new version!
Responses
chevron-right
200

Success

application/json
messagestringRequired

Message

Example: Message
updatedAtstringRequired

Date and time when the record was last updated

Example: 2024-02-02T04:29:09.335Z
whitelistedGroupsstring[]Required

List of whitelisted groups

Example: ["Group1","Group2"]
lastMessagestringRequired

Last message content

Example: Completed
versionCountintegerRequired

Version count

Example: 1
prioritystringRequired

Priority level

Example: normal
statusTitlestringRequired

Status title

Example: Pending
privacystringRequired

Privacy setting

Example: none
agenumberRequired

Age value

Example: 0
createdAtstringRequired

Date and time when the record was created

Example: 2024-02-02T04:29:09.182Z
parentintegerRequired

Parent ID

Example: 11
whiteliststring[]Required

List of whitelisted entities

Example: ["UID1","UID2"]
idintegerRequired

ID

Example: 208
privacySettingsobjectRequired

Privacy settings

countintegerRequired

Count value

Example: 0
completedAtstringRequired

Date and time when the chatroom was completed

Example: 2024-02-02T04:17:21.859Z
originSeqNointegerRequired

Origin sequence number

Example: 61
creatorstringRequired

Creator ID

Example: Q79THCOJ5CcvWRMPeIVZiq1ezu42
originChatroomIdintegerRequired

Origin chatroom ID

Example: 11
remindersobjectRequired

Reminders information

currentVersionbooleanRequired

Flag indicating if it is the current version

Example: true
autoNostringRequired

Auto number

Example: 61
archivedbooleanRequired

Flag indicating if the chatroom is archived

Example: false
seqNointegerRequired

Sequence number

Example: 61
addressstringRequired

Address

Example: Y1GW0PGZK
derivedTitlestringRequired

Derived title

Example: Approval Test #61: New-chatroom
statusintegerRequired

Status

Example: -1
processWhitelistGroupsstring[]Required

List of process whitelist groups

versionCommentstringRequired

Version comment

Example: Comment
lastMessageAuthorstringRequired

Last message author

Example: unibot
processTitlestringRequired

Process title

Example: Approval Test
titlestringRequired

Title

Example: New-chatroom
typestringRequired

Type

Example: workflow
childCountintegerRequired

Child count value

Example: 0
processOwnersstring[]Required

List of process owners

versionintegerRequired

Version value

Example: 1
metastringRequired

Meta information

Example: Meta Information
completedBystringRequired

Completed by information

Example: UID
memberCountintegerRequired

Member count value

Example: 2
dueDatestringRequired

Due date

Example: 2023-01-22
activebooleanRequired

Flag indicating if the chatroom is active

Example: true
groupMembersobjectRequired

Group members information

templateIdintegerRequired

Template ID

Example: 33
outcomestringRequired

List of outcome entities

breadcrumbsstringRequired

List of breadcrumb entities

groupsstring[]Required

List of group IDs

orgIdintegerRequired

Organization ID

Example: 1
processWhiteliststring[]Required

List of process whitelist entities

descriptionstringRequired

Description

canceledbooleanRequired

Flag indicating if the record is canceled

Example: false
patch
/chatroom/{id}

Last updated