curl --location --request POST 'https://api.userorbit.com/v1/public/topic-comments.list' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"id": "topic-uuid-123",
"sort": "createdAt",
"direction": "DESC"
}'
curl --location --request POST 'https://api.userorbit.com/v1/public/topic-comments.list' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"sort": "createdAt",
"direction": "DESC"
}'
const response = await fetch('https://api.userorbit.com/v1/public/topic-comments.list', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
id: topicId,
sort: 'createdAt',
direction: 'DESC'
})
});
const { data: comments } = await response.json();
{
"data": [
{
"id": "comment-uuid-1",
"text": "Great feature idea!",
"topicId": "topic-uuid-123",
"creatorId": "sub-uuid-1",
"parentId": null,
"source": "widget",
"createdAt": "2024-01-17T16:30:00Z",
"subscriber": {
"id": "sub-uuid-1",
"name": "John Doe",
"email": "john@example.com"
},
"replies": [
{
"id": "comment-uuid-2",
"text": "I agree!",
"parentId": "comment-uuid-1",
"createdAt": "2024-01-17T17:00:00Z",
"subscriber": {
"id": "sub-uuid-2",
"name": "Jane Smith",
"email": "jane@example.com"
}
}
]
}
],
"pagination": {
"offset": 0,
"limit": 50
}
}
Comments
List Topic Comments
Get all comments on a topic with nested replies. Supports sorting and pagination.
POST
/
v1
/
public
/
topic-comments.list
curl --location --request POST 'https://api.userorbit.com/v1/public/topic-comments.list' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"id": "topic-uuid-123",
"sort": "createdAt",
"direction": "DESC"
}'
curl --location --request POST 'https://api.userorbit.com/v1/public/topic-comments.list' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"sort": "createdAt",
"direction": "DESC"
}'
const response = await fetch('https://api.userorbit.com/v1/public/topic-comments.list', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
id: topicId,
sort: 'createdAt',
direction: 'DESC'
})
});
const { data: comments } = await response.json();
{
"data": [
{
"id": "comment-uuid-1",
"text": "Great feature idea!",
"topicId": "topic-uuid-123",
"creatorId": "sub-uuid-1",
"parentId": null,
"source": "widget",
"createdAt": "2024-01-17T16:30:00Z",
"subscriber": {
"id": "sub-uuid-1",
"name": "John Doe",
"email": "john@example.com"
},
"replies": [
{
"id": "comment-uuid-2",
"text": "I agree!",
"parentId": "comment-uuid-1",
"createdAt": "2024-01-17T17:00:00Z",
"subscriber": {
"id": "sub-uuid-2",
"name": "Jane Smith",
"email": "jane@example.com"
}
}
]
}
],
"pagination": {
"offset": 0,
"limit": 50
}
}
Authentication
Authorization: Bearer YOUR_API_KEY
Request Body
string
Topic ID (UUID). If not provided, returns comments from all team topics.
string
default:"createdAt"
Field to sort by (createdAt, updatedAt)
string
default:"DESC"
Sort direction (ASC or DESC)
Response
array
Array of comment objects with nested replies
object
Pagination metadata
curl --location --request POST 'https://api.userorbit.com/v1/public/topic-comments.list' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"id": "topic-uuid-123",
"sort": "createdAt",
"direction": "DESC"
}'
curl --location --request POST 'https://api.userorbit.com/v1/public/topic-comments.list' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"sort": "createdAt",
"direction": "DESC"
}'
const response = await fetch('https://api.userorbit.com/v1/public/topic-comments.list', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
id: topicId,
sort: 'createdAt',
direction: 'DESC'
})
});
const { data: comments } = await response.json();
{
"data": [
{
"id": "comment-uuid-1",
"text": "Great feature idea!",
"topicId": "topic-uuid-123",
"creatorId": "sub-uuid-1",
"parentId": null,
"source": "widget",
"createdAt": "2024-01-17T16:30:00Z",
"subscriber": {
"id": "sub-uuid-1",
"name": "John Doe",
"email": "john@example.com"
},
"replies": [
{
"id": "comment-uuid-2",
"text": "I agree!",
"parentId": "comment-uuid-1",
"createdAt": "2024-01-17T17:00:00Z",
"subscriber": {
"id": "sub-uuid-2",
"name": "Jane Smith",
"email": "jane@example.com"
}
}
]
}
],
"pagination": {
"offset": 0,
"limit": 50
}
}
Behavior
- Hierarchical: Returns top-level comments with nested replies
- Team-Wide: If no topic ID provided, returns comments from all team topics
- Includes Topic: When listing all comments, includes topic details for context
Use Cases
- Topic Discussion: Display all comments on a topic
- Zapier Integration: Fetch all new topic comments across roadmap
- Activity Feed: Show recent topic activity
Notes
- Without topic ID, fetches from all team topics (useful for Zapier)
- Returns empty array if topic has no comments
- Deleted subscribers still shown in comment history
Was this page helpful?

