Skip to main content
GET
/
api
/
public
/
community
/
board
/
threads

List Discussion Threads

Returns a list of discussion board threads for the community feature. Supports filtering by group, inbox type, keyword search, and tag.

Authentication

Requires a valid customer bearer token.

Query Parameters

groupId
number
required
Filter threads to a specific discussion group.
inbox
string
Inbox filter (e.g. null for all, or specific inbox type).
query
string
Keyword search filter.
tag
string
Filter by tag name.
_shape
string
Comma-separated list of field paths to include in the response. When provided, only the specified fields are returned — useful for reducing payload size. Supports nested paths using dot notation. Example: _shape=Records.Subject,Records.LastMessageUtc,Records.MessageCount.

Response

Returns a paginated list of thread summary objects.

Thread Summary Fields

Identity

FieldTypeDescription
IdnumberUnique numeric identifier for the thread
UniqueIdstringGlobally unique identifier
ThreadUniqueIdstringThread-specific unique identifier

Content

FieldTypeDescription
SubjectstringThread subject / title
MessagestringOriginal post content
Tagsstring[]Array of tag strings
PrivatebooleanWhether the thread is private

Author

FieldTypeDescription
UserIdnumberAuthor user identifier
CoworkerIdnumberAuthor coworker identifier
FullNamestringAuthor full name
ShortFullNamestringAbbreviated name (first + initial)

Group & Location

FieldTypeDescription
GroupIdnumberDiscussion group identifier
GroupNamestringDiscussion group display name
BusinessIdnumberLocation identifier
BusinessNamestringLocation display name
BusinessWebAddressstringLocation subdomain identifier

Activity

FieldTypeDescription
MessageCountnumberTotal number of replies
LikeCountnumberTotal number of likes
LastMessagestring | nullLast reply date (business-local)
LastMessageUtcstring | nullLast reply date (UTC)
LastMessageTextstringLast reply message text
LastMessageUserFullNamestringName of last reply author
LastMessageCoworkerIdnumber | nullCoworker id of last reply author
LastMessageIdnumber | nullId of the last reply message

Participation

FieldTypeDescription
Participantsstring[]Array of participant identifiers
FullNamesstring[]Array of participant full names
Likesstring[]Array of users who liked the thread
FileIDsstring[]Array of attached file identifiers
FileNamesstring[]Array of attached file names

User State

FieldTypeDescription
MutedForUserbooleanWhether muted by the current user
FollowedByUserbooleanWhether followed by the current user
LikedByUserbooleanWhether liked by the current user

Timestamps

FieldTypeDescription
PostedOnstringDate posted (business-local time)
PostedOnUtcstringDate posted (UTC)
CreatedOnstringDate created (business-local time)
UpdatedOnstring | nullDate last updated (business-local time)
CreatedOnUtcstringDate created (UTC)
UpdatedOnUtcstring | nullDate last updated (UTC)

Examples

Fetch threads in a group

GET /api/public/community/board/threads?groupId=1&inbox=&query=&tag=
Authorization: Bearer {token}

TypeScript Integration

import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.community.board.list(1))