Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Daniel-Stojanovski/finkiopendesk/llms.txt

Use this file to discover all available pages before exploring further.

Channels are topic-specific discussion spaces tied to a subject tag. Each channel holds an ordered list of comments and is linked to exactly one SubjectTag. All channel endpoints are publicly accessible — no authentication token is needed to read channel data.

GET /api/channels

Returns all channels on the platform, regardless of their active or inactive status. The response is the raw Channel entity serialized directly — no DTO projection is applied at this level.

Response

An array of Channel objects.
channelId
string
required
Unique identifier for the channel.
name
string
required
Display name of the channel.
description
string
Description of the channel’s purpose. May be null.
subjectTag
object
The subject-tag this channel is linked to. A channel is considered active when its associated subjectTag has statusActive: true.
comments
Comment[]
Comments posted in this channel, ordered ascending by createdAt. Comment structure mirrors CommentDto — see the comment fields reference for field details.
curl https://finkiopendesk.onrender.com/api/channels

GET /api/channels/active

Returns only channels whose linked subject tag has statusActive: true.

Response

An array of Channel objects — same schema as above, containing only active channels.
curl https://finkiopendesk.onrender.com/api/channels/active

GET /api/channels/inactive

Returns only channels whose linked subject tag has statusActive: false.

Response

An array of Channel objects — same schema as above, containing only inactive channels.
curl https://finkiopendesk.onrender.com/api/channels/inactive

GET /api/channels/cid/

Returns a single channel by its ID, projected through ChannelDto. This is the recommended endpoint when you need a channel’s full comment thread, because the DTO projection ensures a clean, consistent shape.

Path parameters

id
string
required
The unique identifier of the channel to retrieve.

Response

Returns a single ChannelDto object.
channelId
string
required
Unique identifier for the channel.
name
string
required
Display name of the channel.
description
string
Description of the channel’s purpose. May be null.
subjectTag
object
The subject-tag this channel is linked to. Uses the same SubjectTagDto schema described above.
comments
CommentDto[]
All comments in this channel ordered ascending by creation time.
curl https://finkiopendesk.onrender.com/api/channels/cid/channel-001

Build docs developers (and LLMs) love