Connecting to BugHerd

Using API Key Authentication

BugHerd uses HTTP Basic authentication with an API key as the username. To obtain an API key:

Sign in to your BugHerd account at https://www.bugherd.com
Navigate to Settings > General Settings
Locate the API Key section and copy the generated key

After obtaining your API key, set the following connection properties:

AuthScheme: Set this to APIKey.

Set the following in the ProfileSettings connection property:

APIKey: Set this to your BugHerd API key. The driver uses the key as the Basic auth username and sets the password internally to the literal value 'x' as required by BugHerd.

Example Connection String

Profile=C:\profiles\BugHerd.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

Connecting to BugHerd

Once authentication is configured, you can connect to BugHerd and query data from any of the available tables such as Projects, Tasks, Comments, and Users.

Available Tables

The BugHerd API Profile provides access to the following tables:

Projects: Returns BugHerd projects in your organization. Supports list and detail by Id; the detail response includes embedded members, guests, and columns arrays.
ActiveProjects: Filtered view of Projects returning only currently active projects.
Tasks: Returns tasks within a project. Supports list and detail by task Id. Requires ProjectId. Filterable by status, priority, tag, assigned_to_id, external_id, created_since, and updated_since.
FeedbackTasks: Tasks awaiting triage (feedback queue) for a project. Requires ProjectId.
ArchiveTasks: Archived/closed tasks for a project. Requires ProjectId.
KanbanBoardTasks: Tasks visible on the kanban board (excludes feedback and archive). Requires ProjectId.
TaskDetails: Single task fetched by global Id without requiring the parent ProjectId. Returns the full task detail payload.
LocalTasks: Single task fetched by per-project local task ID. Requires both ProjectId and LocalTaskId.
KanbanColumns: Kanban columns (statuses) configured for a project. Requires ProjectId.
Comments: Comments on a task. Requires both ProjectId and TaskId.
Attachments: File attachments on a task. Requires both ProjectId and TaskId.
Users: All people in your BugHerd organization (members and guests/clients combined).
Members: Users with the Member role; subset of Users.
Guests: Users with the Guest role; subset of Users (now displayed as 'clients' in the BugHerd UI).
UserProjects: Projects accessible to a specific user. Requires UserId.
UserTasks: Tasks created or assigned to a specific user. Requires UserId.

Important Notes

BugHerd uses HTTP Basic authentication with the API key as the username and the literal value 'x' as the password (handled internally by the driver).
Some tables require a parent identifier (ProjectId, TaskId, or UserId) to be specified as a filter.
Pagination is fixed at 100 records per page; the page parameter is used for navigation.
Rate limit is 60 requests per minute (sliding window) with bursts up to 10. HTTP 429 is returned when exceeded.
Date fields use ISO 8601 format (yyyy-MM-dd'T'HH:mm:ssZ).
Members and guests are returned inline within the Projects detail response (Members, Guests, and Columns aggregate columns) rather than via dedicated endpoints.
The 'Guests' role is now displayed as 'clients' in the BugHerd UI but the API endpoints retain the 'guests' name unchanged.

API Documentation

For more information about the BugHerd API, see the official BugHerd API documentation.

Usage Examples

Projects:

SELECT * FROM Projects

ActiveProjects:

SELECT * FROM ActiveProjects

Tasks:

SELECT * FROM Tasks WHERE ProjectId = 519666

FeedbackTasks:

SELECT * FROM FeedbackTasks WHERE ProjectId = 519666

ArchiveTasks:

SELECT * FROM ArchiveTasks WHERE ProjectId = 519666

KanbanBoardTasks:

SELECT * FROM KanbanBoardTasks WHERE ProjectId = 519666

TaskDetails:

SELECT * FROM TaskDetails WHERE Id = 29573832

LocalTasks:

SELECT * FROM LocalTasks WHERE ProjectId = 519666 AND LocalTaskId = 1

KanbanColumns:

SELECT * FROM KanbanColumns WHERE ProjectId = 519666

Comments:

SELECT * FROM Comments WHERE ProjectId = 519666 AND TaskId = 29573832

Attachments:

SELECT * FROM Attachments WHERE ProjectId = 519666 AND TaskId = 29573832

Users:

SELECT * FROM Users

Members:

SELECT * FROM Members

Guests:

SELECT * FROM Guests

UserProjects:

SELECT * FROM UserProjects WHERE UserId = 599573

UserTasks:

SELECT * FROM UserTasks WHERE UserId = 599573

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

Property	Description
APIKey	Your BugHerd API key.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD