Bugsnag

bugsnag Comments API

Manage comments on errors. Comments allow team members to discuss and annotate specific errors.

GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /projects/{project_id}/errors/{error_id}/comments List comments on an error · List error comments #
Ask an LLM
“What has my team said about this error?”
“Can I read all the discussion notes left on an error?”
Tell an agent
List comments on error {error_id} in project {project_id}.
Show the team discussion for error {error_id} in project {project_id}.
POST /projects/{project_id}/errors/{error_id}/comments Comment on an error · Create a comment on an error #
Ask an LLM
“How do I leave a note on an error for my teammates?”
“Can comments on errors include formatting or only plain text?”
Tell an agent
Comment "{message}" on error {error_id} in project {project_id}.
Add a note to error {error_id} in project {project_id} saying {message}.
GET /projects/{project_id}/errors/{error_id}/comments/{comment_id} Get a single error comment · Get a comment #
Ask an LLM
“How do I fetch one specific comment on an error?”
“Can I see who wrote a particular comment and when?”
Tell an agent
Show comment {comment_id} on error {error_id} in project {project_id}.
Open comment {comment_id} from error {error_id} of project {project_id}.
PATCH /projects/{project_id}/errors/{error_id}/comments/{comment_id} Edit a comment on a project's error · Update a comment #
Ask an LLM
“How do I fix a typo in a comment I left on an error?”
“Can I change the text of an existing error comment?”
Tell an agent
Change comment {comment_id} on error {error_id} in project {project_id} to {message}.
Edit comment {comment_id} under error {error_id} of project {project_id} to read {message}.
DELETE /projects/{project_id}/errors/{error_id}/comments/{comment_id} Delete a comment on a project's error · Delete a comment #
Ask an LLM
“Can I permanently remove a comment I posted on an error?”
“Is deleting an error comment reversible?”
Tell an agent destructive · confirm first
Delete comment {comment_id} on error {error_id} in project {project_id}.
Remove the comment {comment_id} from error {error_id} in project {project_id} for good.

Documentation

📖
Documentation
https://developer.smartbear.com/bugsnag/docs/data-access
📖
APIReference
https://developer.smartbear.com/bugsnag

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bugsnag/refs/heads/main/openapi/bugsnag-comments-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/bugsnag:bugsnag-comments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

bugsnag-comments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Bugsnag Data Access Comments API
  description: The Bugsnag Data Access API provides programmatic access to information about your organization, projects, errors, events, and more. It allows developers to build custom integrations and dashboards using their Bugsnag data. The REST API uses JSON and requires authentication via a personal auth token sent in the Authorization header. It supports querying error trends, project configurations, collaborators, and release information.
  version: '2.0'
  contact:
    name: Bugsnag Support
    url: https://docs.bugsnag.com/api/data-access/
  termsOfService: https://smartbear.com/terms-of-use/
servers:
- url: https://api.bugsnag.com
  description: Bugsnag Production API Server
security:
- tokenAuth: []
tags:
- name: Comments
  description: Manage comments on errors. Comments allow team members to discuss and annotate specific errors.
paths:
  /projects/{project_id}/errors/{error_id}/comments:
    get:
      operationId: listErrorComments
      summary: List error comments
      description: Returns a list of comments for the specified error. Comments allow team members to discuss and annotate errors.
      tags:
      - Comments
      parameters:
      - $ref: '#/components/parameters/ProjectId'
      - $ref: '#/components/parameters/ErrorId'
      - $ref: '#/components/parameters/PerPage'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Comment'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Error not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      operationId: createErrorComment
      summary: Create a comment on an error
      description: Creates a new comment on the specified error. Comments support plain text content.
      tags:
      - Comments
      parameters:
      - $ref: '#/components/parameters/ProjectId'
      - $ref: '#/components/parameters/ErrorId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommentCreate'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Comment'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /projects/{project_id}/errors/{error_id}/comments/{comment_id}:
    get:
      operationId: getComment
      summary: Get a comment
      description: Returns the details of a specific comment on an error.
      tags:
      - Comments
      parameters:
      - $ref: '#/components/parameters/ProjectId'
      - $ref: '#/components/parameters/ErrorId'
      - $ref: '#/components/parameters/CommentId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Comment'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Comment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    patch:
      operationId: updateComment
      summary: Update a comment
      description: Updates the content of an existing comment on an error.
      tags:
      - Comments
      parameters:
      - $ref: '#/components/parameters/ProjectId'
      - $ref: '#/components/parameters/ErrorId'
      - $ref: '#/components/parameters/CommentId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommentCreate'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Comment'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Comment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      operationId: deleteComment
      summary: Delete a comment
      description: Permanently deletes a comment from an error.
      tags:
      - Comments
      parameters:
      - $ref: '#/components/parameters/ProjectId'
      - $ref: '#/components/parameters/ErrorId'
      - $ref: '#/components/parameters/CommentId'
      responses:
        '204':
          description: Comment deleted successfully
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Comment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    ProjectId:
      name: project_id
      in: path
      required: true
      description: The unique identifier of the project.
      schema:
        type: string
    PerPage:
      name: per_page
      in: query
      description: The number of results to return per page. Used for pagination.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 30
    CommentId:
      name: comment_id
      in: path
      required: true
      description: The unique identifier of the comment.
      schema:
        type: string
    ErrorId:
      name: error_id
      in: path
      required: true
      description: The unique identifier of the error.
      schema:
        type: string
  schemas:
    User:
      type: object
      description: Represents an authenticated Bugsnag user account.
      properties:
        id:
          type: string
          description: The unique identifier of the user.
        name:
          type: string
          description: The full name of the user.
        email:
          type: string
          format: email
          description: The email address associated with the user account.
        gravatar_url:
          type: string
          format: uri
          description: The Gravatar URL for the user's profile image.
        html_url:
          type: string
          format: uri
          description: The URL to the user's Bugsnag dashboard profile.
    CommentCreate:
      type: object
      description: Request body for creating or updating a comment.
      required:
      - message
      properties:
        message:
          type: string
          description: The text content of the comment.
    Error:
      type: object
      description: An API error response.
      properties:
        errors:
          type: array
          items:
            type: string
          description: List of error messages.
    Comment:
      type: object
      description: Represents a comment on an error, used for team discussion and annotation.
      properties:
        id:
          type: string
          description: The unique identifier of the comment.
        error_id:
          type: string
          description: The identifier of the error this comment belongs to.
        author:
          $ref: '#/components/schemas/User'
        message:
          type: string
          description: The text content of the comment.
        created_at:
          type: string
          format: date-time
          description: The date and time the comment was created.
        updated_at:
          type: string
          format: date-time
          description: The date and time the comment was last updated.
  securitySchemes:
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Personal auth token sent as "token YOUR-AUTH-TOKEN". The token can be found in the Bugsnag account settings under the API section.
externalDocs:
  description: Bugsnag Data Access API Documentation
  url: https://docs.bugsnag.com/api/data-access/