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

List Discussion Groups

Returns the list of discussion board groups (categories/channels) available in the community. Used to populate group selectors and navigation.

Authentication

Requires a valid customer bearer token.

Query Parameters

_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=Groups.Name,Groups.Description.

Response

Returns an array of group objects with the following fields.

Group Fields

Identity

FieldTypeDescription
IdnumberUnique numeric identifier for the group
UniqueIdstringGlobally unique identifier

Core

FieldTypeDescription
NamestringGroup display name
DescriptionstringGroup description
GroupAccessstringAccess level (e.g. Public, Private)
CanPostMessagesbooleanWhether the current user can post messages in this group

Nested Objects

FieldTypeDescription
BusinessobjectLocation object (Id, Name, WebAddress)
UserobjectGroup owner object (Id, FullName, etc.)

Timestamps (from base)

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

Examples

Fetch groups

GET /api/public/community/board/groups
Authorization: Bearer {token}

TypeScript Integration

import endpoints from '@/api/endpoints'

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