Skip to main content
Every bugsnag.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.
New to Corsair? See API access, authentication, and error handling.

Collaborators

delete

collaborators.delete Remove a collaborator, revoking access to every project in the organization Risk: destructive
Input Output

get

collaborators.get Get a single collaborator Risk: read
Input Output

getOnProject

collaborators.getOnProject Get a collaborator in the context of a project Risk: read
Input Output

getProjectAccess

collaborators.getProjectAccess Get how one collaborator reaches one project Risk: read
Input Output

invite

collaborators.invite Invite a collaborator to an organization by email address Risk: write
Input Output

list

collaborators.list List the collaborators on an organization Risk: read
Input Output: object[]

listOnProject

collaborators.listOnProject List the collaborators who can reach a project Risk: read
Input Output: object[]

listProjectAccesses

collaborators.listProjectAccesses List how a collaborator reaches each project, with the granting role Risk: read
Input Output: object[]

listProjects

collaborators.listProjects List the projects a collaborator can reach Risk: read
Input Output: object[]

projectAccessCounts

collaborators.projectAccessCounts Count how many projects each named collaborator can reach Risk: read
Input Output: object[]

updatePermissions

collaborators.updatePermissions Change a collaborator’s project access or admin status Risk: write
Input
Output

Data Deletions

confirmForProject

dataDeletions.confirmForProject Confirm a project event data deletion, irreversibly erasing the matched data Risk: destructive
Input Output

createForOrganization

dataDeletions.createForOrganization Create a request to erase matching event data across an organization Risk: destructive
Input
Output

createForProject

dataDeletions.createForProject Create a request to erase matching event data in a project Risk: destructive
Input
Output

getForOrganization

dataDeletions.getForOrganization Check the status of an organization event data deletion Risk: read
Input Output

getForProject

dataDeletions.getForProject Check the status of a project event data deletion Risk: read
Input Output

Data Requests

createForOrganization

dataRequests.createForOrganization Request an export of an organization’s event data for a subject access request Risk: write
Input
Output

createForProject

dataRequests.createForProject Request an export of a project’s event data for a subject access request Risk: write
Input
Output

getForOrganization

dataRequests.getForOrganization Check the status of an organization event data export Risk: read
Input Output

getForProject

dataRequests.getForProject Check the status of a project event data export Risk: read
Input Output

Errors

bulkUpdate

errors.bulkUpdate Apply one operation to many errors at once, including delete and discard Risk: destructive
Input
Output

deleteAll

errors.deleteAll Permanently delete every error and event in a project Risk: destructive
Input Output

list

errors.list List the error groups on a project Risk: read
Input
Output: object[]

Event Fields

create

eventFields.create Create a custom event field from a path inside event metadata Risk: write
Input
Output

delete

eventFields.delete Delete a custom event field Risk: destructive
Input Output

list

eventFields.list List the fields a project can filter and pivot on Risk: read
Input Output: object[]

Events

list

events.list List the individual event occurrences on a project Risk: read
Input
Output: object[]

listForError

events.listForError List the individual events belonging to one error Risk: read
Input
Output: object[]

Feature Flags

list

featureFlags.list List the feature flags seen on a project in a release stage Risk: read
Input Output: object[]

listSummaries

featureFlags.listSummaries List feature flag summaries for a project Risk: read
Input Output: object[]

Integrations

configure

integrations.configure Configure an integration on a project Risk: write
Input
Output

deleteConfigured

integrations.deleteConfigured Delete a configured integration Risk: destructive
Input Output

getConfigured

integrations.getConfigured Get a single configured integration Risk: read
Input Output

listConfigured

integrations.listConfigured List the integrations configured on a project Risk: read
Input Output: object[]

listSupported

integrations.listSupported List every integration BugSnag supports Risk: read
Input Output: object[]

test

integrations.test Test an integration configuration before creating it Risk: read
Input
Output

Organizations

delete

organizations.delete Delete an organization with all of its projects, errors and collaborator access Risk: destructive
Input Output

get

organizations.get Get a single organization Risk: read
Input Output

list

organizations.list List the organizations the token’s owner belongs to Risk: read
Input Output: object[]

Pivots

list

pivots.list List the pivot definitions available on a project Risk: read
Input
Output: object[]

values

pivots.values List one pivot’s values with each value’s share of events Risk: read
Input
Output: object[]

Projects

create

projects.create Create a project in an organization Risk: write
Input Output

delete

projects.delete Delete a project and its entire error history Risk: destructive
Input Output

get

projects.get Get a single project Risk: read
Input Output

list

projects.list List the projects in an organization Risk: read
Input Output: object[]

networkGroupingRuleset

projects.networkGroupingRuleset Get a project’s network span grouping ruleset Risk: read
Input Output

regenerateApiKey

projects.regenerateApiKey Rotate a project’s notifier API key, stopping every deployed notifier until redeployed Risk: destructive
Input Output

Releases

list

releases.list List the releases of a project Risk: read
Input Output: object[]

listGroups

releases.listGroups List the release groups of a project within a release stage Risk: read
Input Output: object[]

Saved Searches

create

savedSearches.create Create a saved search from a filter configuration Risk: write
Input
Output

delete

savedSearches.delete Delete a saved search Risk: destructive
Input Output

get

savedSearches.get Get a single saved search Risk: read
Input Output

list

savedSearches.list List the saved searches on a project Risk: read
Input Output: object[]

usageSummary

savedSearches.usageSummary Report what depends on a saved search, to check before deleting it Risk: read
Input Output

Teams

addCollaboratorMemberships

teams.addCollaboratorMemberships Add a collaborator to teams, or to all of them Risk: write
Input Output

addMembers

teams.addMembers Add collaborators to a team, or add all of them Risk: write
Input Output

create

teams.create Create a team in an organization Risk: write
Input Output

delete

teams.delete Delete a team, removing the grouping but not its members Risk: destructive
Input Output

get

teams.get Get a single team Risk: read
Input Output

list

teams.list List the teams in an organization Risk: read
Input Output: object[]

projectBuckets

trends.projectBuckets Get a project’s event counts split into time buckets Risk: read
Input
Output: object[]