BugRelay
Sign inSign up

API Documentation

Integrate BugRelay into your applications and workflows with our RESTful API

Quick Start

Get started with the BugRelay API in minutes

Base URL

https://api.bugrelay.com/v1

Example Request

GET
https://api.bugrelay.com/v1/bugs

Response Format

{
  "data": [...],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "hasNext": true
  }
}

Authentication

Secure your API requests with proper authentication

API Keys

For company-specific operations, you'll need an API key. Get yours from your company dashboard.

Authorization: Bearer your-api-key-here

Public Endpoints

Many endpoints are public and don't require authentication:

  • Viewing bug reports and comments
  • Searching companies and applications
  • Creating new bug reports
  • Voting on bug reports

Protected Endpoints

These operations require authentication:

  • Claiming company ownership
  • Updating bug status
  • Managing team members
  • Accessing company analytics

API Endpoints

Complete reference for all available endpoints

GET
/api/v1/bugs

List all bug reports with filtering and pagination

Parameters:

page
limit
status
priority
company
application
GET
/api/v1/bugs/{id}

Get detailed information about a specific bug report

Parameters:

id
POST
/api/v1/bugs

Create a new bug report

Parameters:

title
description
application
steps
expected
actual
GET
/api/v1/companies

List all companies with their verification status

Parameters:

page
limit
verified
search
GET
/api/v1/companies/{id}

Get company details and public information

Parameters:

id
POST
/api/v1/companies/{id}/claim
Auth Required

Claim ownership of a company (requires verification)

Parameters:

id
email
message
PATCH
/api/v1/companies/{id}/bugs/{bugId}/status
Auth Required

Update bug status (company members only)

Parameters:

id
bugId
status
response

Rate Limits

API usage limits to ensure fair access for all users

1000

Requests/Hour

For unauthenticated requests

5000

Requests/Hour

For authenticated requests

10

Requests/Second

Burst limit for all requests

Rate Limit Headers

All API responses include rate limit information in headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

Error Handling

Understanding API error responses and status codes

HTTP Status Codes

200Success
201Created
400Bad Request
401Unauthorized
403Forbidden
404Not Found
429Rate Limited
500Server Error

Error Response Format

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters",
    "details": {
      "field": "title",
      "issue": "Title is required"
    }
  }
}

SDKs and Tools

Official and community-maintained tools for easier integration

JavaScript/Node.js

Official SDK for JavaScript and Node.js applications

Python

Python SDK with async support and type hints

Postman Collection

Complete API collection for testing and development

API Support

Get help with API integration and troubleshooting

Get API SupportTry API Explorer