Reports and comments
Retrieve reports by ObjectId or slug and safely work with program-visible comments.
Reports and comments
Retrieve a report by slug
POST /report accepts either a MongoDB report ObjectId or the customer-facing
report slug. Preserve leading zeroes by sending slugs as JSON strings.
curl --request POST 'https://api.bugbase.ai/report' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $BUGBASE_API_KEY" \
--data '{
"programId": "000000000000000000000000",
"reportSlug": "EXAMPLE-REPORT-SLUG",
"commentsLimit": 50
}'You can also put a slug in reportId for convenience, but reportSlug makes the
intent clearer. Supply only one of the two fields.
Report details are available for both open and closed reports, including
resolved, invalid, duplicate, and informational reports. Draft and archived
reports are not exposed through the API.
Comment filtering
The comments response contains only chat entries visible to the program.
Internal BugBase triager notes, internal bot notes, participant metadata, raw
storage keys, and cached unsigned URLs are never returned.
{
"comments": {
"items": [
{
"_id": "COMMENT_OBJECT_ID",
"role": "program",
"messageType": "message",
"message": "We are reviewing this report.",
"timestamp": "2026-07-10T11:00:00.000Z",
"isImage": false
}
],
"hasMore": false,
"nextCursor": null
}
}commentsLimit defaults to 50 and accepts 1–100. When hasMore is true, send
nextCursor back as commentsCursor in the next request.
Add a comment
Use POST /report/message with reports:comment. The message must contain
1–6000 characters. It is posted as the program and follows the platform's normal
email, notification, Jira, and webhook behavior.
Updated 4 months ago
