Skip to main content
New to Corsair? See API access, authentication, and error handling.

Columns

create

columns.create Add a custom column at the end of a project board. Risk: write
Input Output

delete

columns.delete Delete an empty column. Cannot be undone. Risk: destructive
Input Output

list

columns.list List the columns on a project board, built-in and custom. Risk: read
Input Output

show

columns.show Get one column. Risk: read
Input Output

update

columns.update Rename a custom column. Risk: write
Input Output

Organization

show

organization.show Get the organization name and id. Risk: read
Input: empty object Output

Projects

addGuest

projects.addGuest Add a guest (client) to a project by user id, or invite one by email. An email invite sends the person a message. Risk: destructive
Input Output

addMember

projects.addMember Add one or more organization members to a project. Risk: write
Input Output

create

projects.create Create a project for a website. Members and guests are added separately. Risk: write
Input Output

delete

projects.delete Delete a project and all its tasks. Cannot be undone. Risk: destructive
Input Output

list

projects.list List every project in the organization, active and inactive. 100 per page. Risk: read
Input Output

listActive

projects.listActive List active projects only. 100 per page. Risk: read
Input Output

show

projects.show Get one project with its members, guests and columns. Risk: read
Input Output

update

projects.update Change a project’s name, URL or settings. Only the fields given change. Risk: write
Input Output

Tasks

create

tasks.create Create a task in a project. Without a status it lands in the Feedback panel. Risk: write
Input Output

createAttachment

tasks.createAttachment Attach a file to a task from a public URL. BugHerd keeps a copy. Risk: write
Input Output

createComment

tasks.createComment Comment on a task, optionally visible to team members only. Risk: write
Input Output

delete

tasks.delete Delete a task. Cannot be undone. Risk: destructive
Input Output

deleteAttachment

tasks.deleteAttachment Remove an attachment from a task. Cannot be undone. Risk: destructive
Input Output

list

tasks.list List tasks in a project, filtered by status, priority, tag, assignee, external id or date. 100 per page. Risk: read
Input Output

listArchived

tasks.listArchived List closed and archived tasks in a project. Risk: read
Input Output

listAttachments

tasks.listAttachments List the files attached to a task. Risk: read
Input Output

listComments

tasks.listComments List the comments on a task. Risk: read
Input Output

listFeedback

tasks.listFeedback List tasks in the Feedback panel (new, not yet triaged). Risk: read
Input Output

listForUser

tasks.listForUser List tasks assigned to a user across all projects. Risk: read
Input GET /users/{user_id}/tasks.json. BugHerd answers with a bare array; the plugin returns it as { tasks } like the other task lists. Output

listTaskboard

tasks.listTaskboard List the active tasks on the project taskboard. Risk: read
Input Output

move

tasks.move Move tasks to another project, by their #numbers. Risk: write
Input POST /projects/{project_id}/move_tasks.json. BugHerd notes the route may not be enabled on every account (404). Output: empty object

show

tasks.show Get one task by its global id, with or without the project id. Risk: read
Input GET /projects/{project_id}/tasks/{task_id}.json, or GET /tasks/{task_id}.json when no project id is given. Output

showAttachment

tasks.showAttachment Get one attachment on a task. Risk: read
Input Output

showByLocalId

tasks.showByLocalId Get a task by the #number shown in the BugHerd UI. Risk: read
Input Output

update

tasks.update Change a task: status (column), priority, assignees, tags, description. Risk: write
Input Output

uploadAttachment

tasks.uploadAttachment Upload a file to a task (a URL, or base64 for a small file). Risk: write
Input POST /projects/{project_id}/tasks/{task_id}/attachments/upload?file_name=... with the file as the raw request body. BugHerd’s reference shows multipart, but the live API stores a multipart upload without its file name. BugHerd allows about 30 seconds per upload; use tasks.createAttachment with a URL for large files.
Output

Users

list

users.list List everyone in the organization, members and guests. Risk: read
Input Output

listGuests

users.listGuests List guests (clients) across all projects. Risk: read
Input Output

listMembers

users.listMembers List team members (not guests). Risk: read
Input Output

listProjects

users.listProjects List the projects a user belongs to. Risk: read
Input Output

Webhooks

create

webhooks.create Subscribe a URL to one BugHerd event, for one project or all of them. Risk: write
Input Output

delete

webhooks.delete Remove a webhook subscription. Cannot be undone. Risk: destructive
Input Output

list

webhooks.list List the organization webhooks with their delivery counts. Risk: read
Input: empty object Output