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

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

Field	Type	Description
`Id`	`number`	Unique numeric identifier for the group
`UniqueId`	`string`	Globally unique identifier

Core

Field	Type	Description
`Name`	`string`	Group display name
`Description`	`string`	Group description
`GroupAccess`	`string`	Access level (e.g. `Public`, `Private`)
`CanPostMessages`	`boolean`	Whether the current user can post messages in this group

Nested Objects

Field	Type	Description
`Business`	`object`	Location object (`Id`, `Name`, `WebAddress`)
`User`	`object`	Group owner object (`Id`, `FullName`, etc.)

Timestamps (from base)

Field	Type	Description
`CreatedOn`	`string`	Date created (business-local time)
`UpdatedOn`	`string \| null`	Date last updated (business-local time)
`CreatedOnUtc`	`string`	Date created (UTC)
`UpdatedOnUtc`	`string \| null`	Date 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)

​List Discussion Groups

​Authentication

​Query Parameters

​Response

​Group Fields

​Identity

​Core

​Nested Objects

​Timestamps (from base)

​Examples

​Fetch groups

​TypeScript Integration