curl --location --request POST 'https://api.userorbit.com/v1/public/stages.info' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"stageId": "stage-uuid",
"limit": 10,
"sort": "voteCount",
"direction": "DESC"
}'
const response = await fetch('https://api.userorbit.com/v1/public/stages.info', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
stageId: 'stage-uuid',
limit: 10,
sort: 'voteCount',
direction: 'DESC'
})
});
const { data: stage, topics, pagination } = await response.json();
import requests
response = requests.post(
'https://api.userorbit.com/v1/public/stages.info',
headers={
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
json={
'stageId': 'stage-uuid',
'limit': 10,
'sort': 'voteCount',
'direction': 'DESC'
}
)
result = response.json()
stage = result['data']
topics = result['topics']
{
"data": {
"id": "stage-uuid-1",
"name": "Under Consideration",
"roadmapId": "roadmap-uuid",
"order": 1,
"meta": {
"isPrivate": false,
"disableModeration": false,
"color": "#E5E7EB"
},
"topicCount": 23,
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-01T00:00:00Z"
},
"topics": [
{
"id": "topic-uuid-1",
"title": "Add mobile app",
"description": "Native mobile apps for iOS and Android",
"voteCount": 156,
"commentCount": 23,
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
{
"id": "topic-uuid-2",
"title": "Dark mode support",
"description": "Add dark mode theme option",
"voteCount": 89,
"commentCount": 12,
"createdAt": "2024-01-14T09:00:00Z",
"updatedAt": "2024-01-14T09:00:00Z"
}
],
"pagination": {
"total": 23,
"limit": 10,
"offset": 0
}
}
Stages
Get Stage Info
Get detailed information about a specific stage including its topics.
POST
/
v1
/
public
/
stages.info
curl --location --request POST 'https://api.userorbit.com/v1/public/stages.info' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"stageId": "stage-uuid",
"limit": 10,
"sort": "voteCount",
"direction": "DESC"
}'
const response = await fetch('https://api.userorbit.com/v1/public/stages.info', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
stageId: 'stage-uuid',
limit: 10,
sort: 'voteCount',
direction: 'DESC'
})
});
const { data: stage, topics, pagination } = await response.json();
import requests
response = requests.post(
'https://api.userorbit.com/v1/public/stages.info',
headers={
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
json={
'stageId': 'stage-uuid',
'limit': 10,
'sort': 'voteCount',
'direction': 'DESC'
}
)
result = response.json()
stage = result['data']
topics = result['topics']
{
"data": {
"id": "stage-uuid-1",
"name": "Under Consideration",
"roadmapId": "roadmap-uuid",
"order": 1,
"meta": {
"isPrivate": false,
"disableModeration": false,
"color": "#E5E7EB"
},
"topicCount": 23,
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-01T00:00:00Z"
},
"topics": [
{
"id": "topic-uuid-1",
"title": "Add mobile app",
"description": "Native mobile apps for iOS and Android",
"voteCount": 156,
"commentCount": 23,
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
{
"id": "topic-uuid-2",
"title": "Dark mode support",
"description": "Add dark mode theme option",
"voteCount": 89,
"commentCount": 12,
"createdAt": "2024-01-14T09:00:00Z",
"updatedAt": "2024-01-14T09:00:00Z"
}
],
"pagination": {
"total": 23,
"limit": 10,
"offset": 0
}
}
Authentication
Authorization: Bearer YOUR_API_KEY
Request Body
string
required
The stage ID to get information for
number
default:"50"
Number of topics to return
number
default:"0"
Number of topics to skip for pagination
string
default:"createdAt"
Field to sort topics by (createdAt, updatedAt, title, voteCount)
string
default:"DESC"
Sort direction (ASC or DESC)
Response
object
array
object
curl --location --request POST 'https://api.userorbit.com/v1/public/stages.info' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"stageId": "stage-uuid",
"limit": 10,
"sort": "voteCount",
"direction": "DESC"
}'
const response = await fetch('https://api.userorbit.com/v1/public/stages.info', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
stageId: 'stage-uuid',
limit: 10,
sort: 'voteCount',
direction: 'DESC'
})
});
const { data: stage, topics, pagination } = await response.json();
import requests
response = requests.post(
'https://api.userorbit.com/v1/public/stages.info',
headers={
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
json={
'stageId': 'stage-uuid',
'limit': 10,
'sort': 'voteCount',
'direction': 'DESC'
}
)
result = response.json()
stage = result['data']
topics = result['topics']
{
"data": {
"id": "stage-uuid-1",
"name": "Under Consideration",
"roadmapId": "roadmap-uuid",
"order": 1,
"meta": {
"isPrivate": false,
"disableModeration": false,
"color": "#E5E7EB"
},
"topicCount": 23,
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-01T00:00:00Z"
},
"topics": [
{
"id": "topic-uuid-1",
"title": "Add mobile app",
"description": "Native mobile apps for iOS and Android",
"voteCount": 156,
"commentCount": 23,
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
{
"id": "topic-uuid-2",
"title": "Dark mode support",
"description": "Add dark mode theme option",
"voteCount": 89,
"commentCount": 12,
"createdAt": "2024-01-14T09:00:00Z",
"updatedAt": "2024-01-14T09:00:00Z"
}
],
"pagination": {
"total": 23,
"limit": 10,
"offset": 0
}
}
Behavior
- Includes Topics: Returns topics currently in this stage
- Paginated: Topics are paginated for performance
- Sortable: Topics can be sorted by various fields
- Public Only: Private stages return 404 for non-team members
Use Cases
- Stage Detail View: Show all topics in a specific stage
- Kanban Column: Display topics within a stage column
- Progress Tracking: Monitor items in each stage
Notes
- Topics include vote and comment counts
- Returns 404 if stage is private and user is not a team member
- Pagination allows efficient loading of stages with many topics
- Stage metadata includes color for visual customization
Was this page helpful?

