> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# bugsnag-organizations
> Bugsnag Organizations - organizations, users, and collaborators
**Server path:** `/bugsnag-organizations` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| [`bugsnag_organizations_add_organization_collaborator_team_memberships`](#bugsnag_organizations_add_organization_collaborator_team_memberships) | Add a collaborator to a group of Teams |
| [`bugsnag_organizations_add_organization_team_memberships`](#bugsnag_organizations_add_organization_team_memberships) | Add Collaborators to a Team |
| [`bugsnag_organizations_bulk_invite_organization_collaborators`](#bugsnag_organizations_bulk_invite_organization_collaborators) | Bulk invite collaborators to your organization |
| [`bugsnag_organizations_create_organization`](#bugsnag_organizations_create_organization) | Create an Organization |
| [`bugsnag_organizations_create_organization_team`](#bugsnag_organizations_create_organization_team) | Create a Team |
| [`bugsnag_organizations_create_saved_search`](#bugsnag_organizations_create_saved_search) | Create a Saved Search |
| [`bugsnag_organizations_delete_organization`](#bugsnag_organizations_delete_organization) | Delete an Organization |
| [`bugsnag_organizations_delete_organization_collaborator`](#bugsnag_organizations_delete_organization_collaborator) | Delete a Collaborator |
| [`bugsnag_organizations_delete_organization_collaborator_team_memberships`](#bugsnag_organizations_delete_organization_collaborator_team_memberships) | Remove a Collaborator from a group of Teams |
| [`bugsnag_organizations_delete_organization_team`](#bugsnag_organizations_delete_organization_team) | Delete a team |
| [`bugsnag_organizations_delete_organization_team_memberships`](#bugsnag_organizations_delete_organization_team_memberships) | Remove Collaborators from a Team |
| [`bugsnag_organizations_delete_organization_team_project_accesses`](#bugsnag_organizations_delete_organization_team_project_accesses) | Remove Project Access from a Team |
| [`bugsnag_organizations_delete_saved_search_by_id`](#bugsnag_organizations_delete_saved_search_by_id) | Delete a Saved Search |
| [`bugsnag_organizations_get_organization_by_id`](#bugsnag_organizations_get_organization_by_id) | View an Organization |
| [`bugsnag_organizations_get_organization_collaborator`](#bugsnag_organizations_get_organization_collaborator) | Show a Collaborator on an Organization |
| [`bugsnag_organizations_get_organization_collaborator_project_access_by_id`](#bugsnag_organizations_get_organization_collaborator_project_access_by_id) | Show a Collaborator's Access Details for a Project |
| [`bugsnag_organizations_get_organization_collaborator_project_access_counts`](#bugsnag_organizations_get_organization_collaborator_project_access_counts) | View the project count of a collaborator |
| [`bugsnag_organizations_get_organization_collaborator_projects`](#bugsnag_organizations_get_organization_collaborator_projects) | View Projects a Collaborator has access to |
| [`bugsnag_organizations_get_organization_projects`](#bugsnag_organizations_get_organization_projects) | List an Organization's Projects |
| [`bugsnag_organizations_get_organization_team`](#bugsnag_organizations_get_organization_team) | Show the details of a team |
| [`bugsnag_organizations_get_project_collaborator`](#bugsnag_organizations_get_project_collaborator) | Show a collaborator in a project. |
| [`bugsnag_organizations_get_saved_search_by_id`](#bugsnag_organizations_get_saved_search_by_id) | Get a Saved Search |
| [`bugsnag_organizations_get_saved_search_usage_summary`](#bugsnag_organizations_get_saved_search_usage_summary) | Get the Usage Summary for a Saved Search |
| [`bugsnag_organizations_invite_organization_collaborator`](#bugsnag_organizations_invite_organization_collaborator) | Invite a collaborator to your organization |
| [`bugsnag_organizations_list_organization_collaborator_project_accesses`](#bugsnag_organizations_list_organization_collaborator_project_accesses) | List project accesses for a collaborator |
| [`bugsnag_organizations_list_organization_collaborator_suggested_teams`](#bugsnag_organizations_list_organization_collaborator_suggested_teams) | List Suggested Teams for a Collaborator |
| [`bugsnag_organizations_list_organization_collaborator_teams`](#bugsnag_organizations_list_organization_collaborator_teams) | List Teams for a Collaborator |
| [`bugsnag_organizations_list_organization_collaborators`](#bugsnag_organizations_list_organization_collaborators) | List all collaborators that are members of your organization |
| [`bugsnag_organizations_list_organization_spans`](#bugsnag_organizations_list_organization_spans) | List Spans for a Trace |
| [`bugsnag_organizations_list_organization_team_collaborators`](#bugsnag_organizations_list_organization_team_collaborators) | List the Collaborators in a Team |
| [`bugsnag_organizations_list_organization_team_project_accesses`](#bugsnag_organizations_list_organization_team_project_accesses) | List Project Access for a Team |
| [`bugsnag_organizations_list_organization_team_suggested_collaborators`](#bugsnag_organizations_list_organization_team_suggested_collaborators) | List Suggested Collaborators to Add to a Team |
| [`bugsnag_organizations_list_organization_team_suggested_projects`](#bugsnag_organizations_list_organization_team_suggested_projects) | Suggest Projects to Add to a Team |
| [`bugsnag_organizations_list_organization_teams`](#bugsnag_organizations_list_organization_teams) | List Teams from a query |
| [`bugsnag_organizations_list_project_collaborators`](#bugsnag_organizations_list_project_collaborators) | List Collaborators on a Project |
| [`bugsnag_organizations_list_project_saved_searches`](#bugsnag_organizations_list_project_saved_searches) | List Saved Searches on a Project |
| [`bugsnag_organizations_list_user_organizations`](#bugsnag_organizations_list_user_organizations) | List the Current User's Organizations |
| [`bugsnag_organizations_organization_event_data_deletions`](#bugsnag_organizations_organization_event_data_deletions) | Create an event deletion request |
| [`bugsnag_organizations_organization_event_data_deletions_by_id`](#bugsnag_organizations_organization_event_data_deletions_by_id) | Check the status of an event deletion request |
| [`bugsnag_organizations_organization_event_data_deletions_confirm`](#bugsnag_organizations_organization_event_data_deletions_confirm) | Confirm an event deletion request |
| [`bugsnag_organizations_organization_event_data_requests`](#bugsnag_organizations_organization_event_data_requests) | Create an event data request |
| [`bugsnag_organizations_organization_event_data_requests_by_id`](#bugsnag_organizations_organization_event_data_requests_by_id) | Check the status of an event data request |
| [`bugsnag_organizations_revoke_organization_api_key`](#bugsnag_organizations_revoke_organization_api_key) | Regenerate an Organization's API key |
| [`bugsnag_organizations_revoke_organization_auth_token`](#bugsnag_organizations_revoke_organization_auth_token) | Regenerate an Organization's auth token |
| [`bugsnag_organizations_update_organization_by_id`](#bugsnag_organizations_update_organization_by_id) | Update an Organization |
| [`bugsnag_organizations_update_organization_collaborator`](#bugsnag_organizations_update_organization_collaborator) | Update a Collaborator's permissions |
| [`bugsnag_organizations_update_organization_team`](#bugsnag_organizations_update_organization_team) | Update a team name |
| [`bugsnag_organizations_update_organization_team_project_accesses`](#bugsnag_organizations_update_organization_team_project_accesses) | Add Project Access to a Team |
| [`bugsnag_organizations_update_saved_search_by_id`](#bugsnag_organizations_update_saved_search_by_id) | Update a Saved Search |
***
## bugsnag\_organizations\_add\_organization\_collaborator\_team\_memberships
Add a collaborator to a group of Teams
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------- |
| `organization_id` | string | Yes | — | The ID of the organization. |
| `id` | string | Yes | — | The ID of the collaborator. |
| `add_all_teams` | boolean | No | — | Whether to assign the collaborator to all teams in the organization |
| `team_ids` | string\[] | No | — | IDs of the teams to assign the collaborator to. This variable is optional, but required if add\_all\_teams is false |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "The ID of the organization."
},
"id": {
"type": "string",
"description": "The ID of the collaborator."
},
"add_all_teams": {
"type": "boolean",
"description": "Whether to assign the collaborator to all teams in the organization"
},
"team_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of the teams to assign the collaborator to. This variable is optional, but required if add_all_teams is false"
}
},
"required": [
"PCID",
"organization_id",
"id"
]
}
```
***
## bugsnag\_organizations\_add\_organization\_team\_memberships
Add Collaborators to a Team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------- |
| `organization_id` | string | Yes | — | ID of the organization |
| `id` | string | Yes | — | the ID of the team |
| `add_all_collaborators` | boolean | No | — | Add all organization collaborators to the team. This should not be set if `collaborator_ids` is specified. |
| `collaborator_ids` | string\[] | No | — | Collaborators to add to the team. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization"
},
"id": {
"type": "string",
"description": "the ID of the team"
},
"add_all_collaborators": {
"type": "boolean",
"description": "Add all organization collaborators to the team. This should not be set if `collaborator_ids` is specified."
},
"collaborator_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Collaborators to add to the team."
}
},
"required": [
"PCID",
"organization_id",
"id"
]
}
```
***
## bugsnag\_organizations\_bulk\_invite\_organization\_collaborators
Bulk invite collaborators to your organization
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `organization_id` | string | Yes | — | the ID of your organization |
| `admin` | boolean | No | — | Whether to give admin permissions to the invited user(s). |
| `emails` | string\[] | Yes | — | A list of emails to invite |
| `project_ids` | string\[] | No | — | The ids of projects in the current organization that the invited user should have access to. Leave blank if the admin field is set to true. Admins have access to all projects. Only one of project\_roles and project\_ids may be supplied. |
| `project_roles` | object | No | — | The IDs of the projects to which the user should have access, and the roles they should have, either 'project\_owner' or 'project\_member'. Leave blank if the admin field is set to true. Admins have access to all projects. Only one of project\_roles and project\_ids may be supplied. This field may only be supplied if the enterprise-roles feature is enabled for the account. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "the ID of your organization"
},
"admin": {
"type": "boolean",
"description": "Whether to give admin permissions to the invited user(s)."
},
"emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of emails to invite"
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ids of projects in the current organization that the invited user should have access to. Leave blank if the admin field is set to true. Admins have access to all projects. Only one of project_roles and project_ids may be supplied."
},
"project_roles": {
"type": "object",
"description": "The IDs of the projects to which the user should have access, and the roles they should have, either 'project_owner' or 'project_member'. Leave blank if the admin field is set to true. Admins have access to all projects. Only one of project_roles and project_ids may be supplied. This field may only be supplied if the enterprise-roles feature is enabled for the account."
}
},
"required": [
"PCID",
"organization_id",
"emails"
]
}
```
***
## bugsnag\_organizations\_create\_organization
Create an Organization
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | --------------------------------------------- |
| `name` | string | Yes | — | Name of the company or organization to create |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Name of the company or organization to create"
}
},
"required": [
"PCID",
"name"
]
}
```
***
## bugsnag\_organizations\_create\_organization\_team
Create a Team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ---------------------- |
| `organization_id` | string | Yes | — | ID of the organization |
| `name` | string | Yes | — | The name value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID",
"organization_id",
"name"
]
}
```
***
## bugsnag\_organizations\_create\_saved\_search
Create a Saved Search
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------- | -------- | ------- | --------------------------------------------------------------------- |
| `filters` | object | Yes | — | The filters value |
| `name` | string | Yes | — | name of the saved search |
| `project_default` | boolean | Yes | — | whether this saved search is the project default for the current user |
| `project_id` | string | Yes | — | ID of project this saved search is for |
| `shared` | boolean | No | — | whether this saved search is shared among collaborators |
| `sort` | string | No | — | Sort order for results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filters": {
"type": "object",
"description": "The filters value",
"properties": {
"user.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user ids. Matches Errors affecting any of these users. This refers to user ids in the context of your application. Exact match only."
},
"user.email": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of email addresses. Matches Errors that have affected users with email addresses matching any of the provided emails. Supports substring matches."
},
"user.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user names. Matches Errors that have affected users with names matching any of the provided names. Supports substring matches."
},
"error.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error ids. Matches errors with IDs matching any of the given error IDs. Exact match only."
},
"error.status": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error statuses. Matches Errors that have any of the given statuses. Exact match only."
},
"error.assigned_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of collaborator identifiers. Matches Errors that have been assigned to any of the given collaborators. Exact match only. Values can be `me` (for errors assigned to the current user), `anyone` (for errors assigned to anyone), a collaborator ID, or an email address."
},
"error.has_issue": {
"type": "boolean",
"description": "If set to true, matches Errors that have had an issue created for them. If set to false, matches Errors that have not had an issue created for them."
},
"app.release_stage": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of release stages. Matches Errors that have occurred in any of the given release stages. Exact match only."
},
"app.context": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application contexts. This refers to the action that was happening when the event occurred. Matches Errors that occurred in any of the given contexts. Supports substring matches."
},
"app.type": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application types. Matches Errors that occurred in any of the given application types. Exact match only."
},
"version.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred for the first time in any of the given versions. Supports the `?` and `*` wildcards."
},
"version.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred in any of the given versions. Supports the `?` and `*` wildcards."
},
"version_code.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred for the first time in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"version_code.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"release.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred for the first time in any of the given Releases. Supports the `?` and `*` wildcards."
},
"release.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred in any of the given Releases. Supports the `?` and `*` wildcards."
},
"feature_flag.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have been seen with these feature flags (any variant), or the specific variant if specified. When type is `ne`, matches errors that have not been seen with these feature flags or variants. The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"feature_flag.exclusive_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have only been seen with one of these feature flags (any variant), or one of the specific variants if specified. When type is `ne`, matches errors that have been seen with these feature flags or variants but are NOT exclusive to them (i.e., they have also been seen with other feature flags or variants). The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"event.class": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of classes. Matches Errors with any of the given classes. Supports substring matches."
},
"event.message": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of messages. Matches Errors with any of the given messages. Supports substring matches."
},
"event.file": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of file paths. Matches Errors with any of the given files in their stack traces'. Supports substring matches."
},
"event.method": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of method names. Matches Errors with any of the given methods in their stack traces'. Supports substring matches."
},
"event.severity": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of severities. Matches Errors with any of the given severities. Exact match only."
},
"event.since": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring after the given time. Exact match only."
},
"event.before": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring before the given time. Exact match only."
},
"browser.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser names. Matches Errors with events originating from any of the given web browsers. Exact match only."
},
"browser.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser versions. Matches Errors with events originating from any browser with the given version. Exact match only."
},
"os.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system names. Matches Errors with events originating from devices running any of the given operating systems. Exact match only."
},
"os.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system versions. Matches Errors with events originating from devices running any of the given operating system versions. Supports the `?` and `*` wildcards."
},
"device.hostname": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing hostnames. Matches Errors with events occurring on any hosts with one of the given hostnames. Exact match only."
},
"device.manufacturer": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device manufacturer names. Matches Errors with events occurring on any devices made by the given manufacturers. Exact match only."
},
"device.model": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device model names. Matches Errors with events occurring on any of the given device models. Exact match only."
},
"request.url": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of URLs. Matches Errors with events associated with requests to any of the given URLs. Supports substring matches."
},
"request.ip": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of IP addresses. Matches Errors with events affecting any of the given IPs. Exact match only."
},
"device.jailbroken": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring on jailbroken devices."
},
"app.in_foreground": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring when the application was in the foreground."
}
}
},
"name": {
"type": "string",
"description": "name of the saved search"
},
"project_default": {
"type": "boolean",
"description": "whether this saved search is the project default for the current user"
},
"project_id": {
"type": "string",
"description": "ID of project this saved search is for"
},
"shared": {
"type": "boolean",
"description": "whether this saved search is shared among collaborators"
},
"sort": {
"type": "string",
"description": "Sort order for results",
"enum": [
"first_seen",
"users",
"events",
"last_seen"
]
}
},
"required": [
"PCID",
"filters",
"name",
"project_default",
"project_id"
]
}
```
***
## bugsnag\_organizations\_delete\_organization
Delete an Organization
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ---------------------- |
| `id` | string | Yes | — | ID of the organization |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "ID of the organization"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## bugsnag\_organizations\_delete\_organization\_collaborator
Delete a Collaborator
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------ |
| `organization_id` | string | Yes | — | the ID of your organization |
| `id` | string | Yes | — | the ID of the collaborator to update |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "the ID of your organization"
},
"id": {
"type": "string",
"description": "the ID of the collaborator to update"
}
},
"required": [
"PCID",
"organization_id",
"id"
]
}
```
***
## bugsnag\_organizations\_delete\_organization\_collaborator\_team\_memberships
Remove a Collaborator from a group of Teams
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | --------------------------- |
| `organization_id` | string | Yes | — | The ID of the organization. |
| `id` | string | Yes | — | The ID of the collaborator. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "The ID of the organization."
},
"id": {
"type": "string",
"description": "The ID of the collaborator."
}
},
"required": [
"PCID",
"organization_id",
"id"
]
}
```
***
## bugsnag\_organizations\_delete\_organization\_team
Delete a team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | -------------------------------- |
| `organization_id` | string | Yes | — | ID of the organization |
| `id` | string | Yes | — | the ID of the team to be deleted |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization"
},
"id": {
"type": "string",
"description": "the ID of the team to be deleted"
}
},
"required": [
"PCID",
"organization_id",
"id"
]
}
```
***
## bugsnag\_organizations\_delete\_organization\_team\_memberships
Remove Collaborators from a Team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ---------------------- |
| `organization_id` | string | Yes | — | ID of the organization |
| `id` | string | Yes | — | the ID of the team |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization"
},
"id": {
"type": "string",
"description": "the ID of the team"
}
},
"required": [
"PCID",
"organization_id",
"id"
]
}
```
***
## bugsnag\_organizations\_delete\_organization\_team\_project\_accesses
Remove Project Access from a Team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ---------------------- |
| `organization_id` | string | Yes | — | ID of the organization |
| `id` | string | Yes | — | the ID of the team |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization"
},
"id": {
"type": "string",
"description": "the ID of the team"
}
},
"required": [
"PCID",
"organization_id",
"id"
]
}
```
***
## bugsnag\_organizations\_delete\_saved\_search\_by\_id
Delete a Saved Search
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------- |
| `id` | string | Yes | — | The ID of the saved search |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of the saved search"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## bugsnag\_organizations\_get\_organization\_by\_id
View an Organization
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------- |
| `id` | string | Yes | — | the ID of the organization |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "the ID of the organization"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## bugsnag\_organizations\_get\_organization\_collaborator
Show a Collaborator on an Organization
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | -------------------------- |
| `organization_id` | string | Yes | — | ID of the organization |
| `id` | string | Yes | — | the ID of the collaborator |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization"
},
"id": {
"type": "string",
"description": "the ID of the collaborator"
}
},
"required": [
"PCID",
"organization_id",
"id"
]
}
```
***
## bugsnag\_organizations\_get\_organization\_collaborator\_project\_access\_by\_id
Show a Collaborator's Access Details for a Project
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | --------------------------- |
| `organization_id` | string | Yes | — | The ID of the organization. |
| `collaborator_id` | string | Yes | — | The ID of the collaborator. |
| `project_id` | string | Yes | — | The ID of the project. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "The ID of the organization."
},
"collaborator_id": {
"type": "string",
"description": "The ID of the collaborator."
},
"project_id": {
"type": "string",
"description": "The ID of the project."
}
},
"required": [
"PCID",
"organization_id",
"collaborator_id",
"project_id"
]
}
```
***
## bugsnag\_organizations\_get\_organization\_collaborator\_project\_access\_counts
View the project count of a collaborator
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | --------- | -------- | ------- | ------------------------------------------------- |
| `organization_id` | string | Yes | — | ID of the organization |
| `collaborator_ids` | string\[] | Yes | — | IDs of collaborators to view the project count of |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization"
},
"collaborator_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of collaborators to view the project count of"
}
},
"required": [
"PCID",
"organization_id",
"collaborator_ids"
]
}
```
***
## bugsnag\_organizations\_get\_organization\_collaborator\_projects
View Projects a Collaborator has access to
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | --------------------------------------------- |
| `organization_id` | string | Yes | — | the ID of the organization |
| `collaborator_id` | string | Yes | — | the ID of the user |
| `q` | string | No | — | Search projects with names matching parameter |
| `sort` | string | No | — | Which field to sort the results by |
| `direction` | string | No | — | Which direction to sort the results by |
| `per_page` | number | No | — | How many results to return per page |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "the ID of the organization"
},
"collaborator_id": {
"type": "string",
"description": "the ID of the user"
},
"q": {
"type": "string",
"description": "Search projects with names matching parameter"
},
"sort": {
"type": "string",
"description": "Which field to sort the results by",
"enum": [
"created_at"
]
},
"direction": {
"type": "string",
"description": "Which direction to sort the results by",
"enum": [
"asc",
"desc"
]
},
"per_page": {
"type": "number",
"description": "How many results to return per page"
}
},
"required": [
"PCID",
"organization_id",
"collaborator_id"
]
}
```
***
## bugsnag\_organizations\_get\_organization\_projects
List an Organization's Projects
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `organization_id` | string | Yes | — | the ID of the organization |
| `q` | string | No | — | Search projects with names matching parameter |
| `sort` | string | No | — | Which field to sort the results by |
| `direction` | string | No | — | Which direction to sort the results by. Defaults to `desc` for all sorts except `favorite`. Defaults to `asc` if sorting by `favorite` (cannot sort `favorite`s `desc`). |
| `per_page` | number | No | — | How many results to return per page |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "the ID of the organization"
},
"q": {
"type": "string",
"description": "Search projects with names matching parameter"
},
"sort": {
"type": "string",
"description": "Which field to sort the results by",
"enum": [
"created_at",
"name",
"favorite"
]
},
"direction": {
"type": "string",
"description": "Which direction to sort the results by. Defaults to `desc` for all sorts except `favorite`. Defaults to `asc` if sorting by `favorite` (cannot sort `favorite`s `desc`).",
"enum": [
"asc",
"desc"
]
},
"per_page": {
"type": "number",
"description": "How many results to return per page"
}
},
"required": [
"PCID",
"organization_id"
]
}
```
***
## bugsnag\_organizations\_get\_organization\_team
Show the details of a team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ---------------------- |
| `organization_id` | string | Yes | — | ID of the organization |
| `id` | string | Yes | — | the ID of the team |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization"
},
"id": {
"type": "string",
"description": "the ID of the team"
}
},
"required": [
"PCID",
"organization_id",
"id"
]
}
```
***
## bugsnag\_organizations\_get\_project\_collaborator
Show a collaborator in a project.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------- |
| `project_id` | string | Yes | — | the ID of the project |
| `id` | string | Yes | — | the ID of the collaborator |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "the ID of the project"
},
"id": {
"type": "string",
"description": "the ID of the collaborator"
}
},
"required": [
"PCID",
"project_id",
"id"
]
}
```
***
## bugsnag\_organizations\_get\_saved\_search\_by\_id
Get a Saved Search
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------- |
| `id` | string | Yes | — | The ID of the saved search |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of the saved search"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## bugsnag\_organizations\_get\_saved\_search\_usage\_summary
Get the Usage Summary for a Saved Search
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------------------------------------------- |
| `id` | string | Yes | — | the ID of the saved search to get a summary for |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "the ID of the saved search to get a summary for"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## bugsnag\_organizations\_invite\_organization\_collaborator
Invite a collaborator to your organization
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `organization_id` | string | Yes | — | the ID of your organization |
| `admin` | boolean | No | — | Whether to give admin permissions to the invited user. |
| `email` | string | Yes | — | The email of the person to invite |
| `name` | string | No | — | A name for the invited user |
| `password` | string | No | — | A password for the invited user |
| `project_ids` | string\[] | No | — | The ids of projects in the current organization that the invited user should have access to. |
| `project_roles` | object | No | — | The IDs of the projects to which the user should have access, and the roles they should have, either 'project\_owner' or 'project\_member'. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "the ID of your organization"
},
"admin": {
"type": "boolean",
"description": "Whether to give admin permissions to the invited user."
},
"email": {
"type": "string",
"description": "The email of the person to invite"
},
"name": {
"type": "string",
"description": "A name for the invited user"
},
"password": {
"type": "string",
"description": "A password for the invited user"
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ids of projects in the current organization that the invited user should have access to."
},
"project_roles": {
"type": "object",
"description": "The IDs of the projects to which the user should have access, and the roles they should have, either 'project_owner' or 'project_member'."
}
},
"required": [
"PCID",
"organization_id",
"email"
]
}
```
***
## bugsnag\_organizations\_list\_organization\_collaborator\_project\_accesses
List project accesses for a collaborator
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | -------------------------- |
| `organization_id` | string | Yes | — | The ID of the organization |
| `collaborator_id` | string | Yes | — | The ID of the collaborator |
| `per_page` | number | No | — | Number of results per page |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "The ID of the organization"
},
"collaborator_id": {
"type": "string",
"description": "The ID of the collaborator"
},
"per_page": {
"type": "number",
"description": "Number of results per page"
}
},
"required": [
"PCID",
"organization_id",
"collaborator_id"
]
}
```
***
## bugsnag\_organizations\_list\_organization\_collaborator\_suggested\_teams
List Suggested Teams for a Collaborator
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `organization_id` | string | Yes | — | ID of the organization |
| `id` | string | Yes | — | the ID of the collaborator |
| `q` | string | No | — | A partial or full team name to filter the results by |
| `include_is_member` | boolean | No | — | Request all teams in the organization, including those that the collaborator is already on. By default only teams the collaborator is not a member of will be returned |
| `per_page` | number | No | — | Number of results per page |
| `offset` | string | No | — | token to retrieve next page of results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization"
},
"id": {
"type": "string",
"description": "the ID of the collaborator"
},
"q": {
"type": "string",
"description": "A partial or full team name to filter the results by"
},
"include_is_member": {
"type": "boolean",
"description": "Request all teams in the organization, including those that the collaborator is already on. By default only teams the collaborator is not a member of will be returned"
},
"per_page": {
"type": "number",
"description": "Number of results per page"
},
"offset": {
"type": "string",
"description": "token to retrieve next page of results"
}
},
"required": [
"PCID",
"organization_id",
"id"
]
}
```
***
## bugsnag\_organizations\_list\_organization\_collaborator\_teams
List Teams for a Collaborator
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `organization_id` | string | Yes | — | ID of the organization |
| `id` | string | Yes | — | the ID of the collaborator |
| `q` | string | No | — | A partial or full team name to filter the results by |
| `per_page` | number | No | — | Number of results per page |
| `offset` | string | No | — | token to retrieve next page of results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization"
},
"id": {
"type": "string",
"description": "the ID of the collaborator"
},
"q": {
"type": "string",
"description": "A partial or full team name to filter the results by"
},
"per_page": {
"type": "number",
"description": "Number of results per page"
},
"offset": {
"type": "string",
"description": "token to retrieve next page of results"
}
},
"required": [
"PCID",
"organization_id",
"id"
]
}
```
***
## bugsnag\_organizations\_list\_organization\_collaborators
List all collaborators that are members of your organization
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------ |
| `organization_id` | string | Yes | — | the ID of your organization |
| `per_page` | number | No | — | Number of results per page |
| `q` | string | No | — | Search collaborators with names or emails matching parameter |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "the ID of your organization"
},
"per_page": {
"type": "number",
"description": "Number of results per page"
},
"q": {
"type": "string",
"description": "Search collaborators with names or emails matching parameter"
}
},
"required": [
"PCID",
"organization_id"
]
}
```
***
## bugsnag\_organizations\_list\_organization\_spans
List Spans for a Trace
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `organization_id` | string | Yes | — | The ID of the Organization to which the spans belong. |
| `trace_id` | string | Yes | — | The ID of the Trace to which the spans belong. |
| `from` | string | Yes | — | Beginning of window to return spans from. |
| `to` | string | Yes | — | End of window to return spans from. |
| `target_span_id` | string | No | — | The ID of a Span within the Trace to focus on. If provided the target Span and its direct children will be returned ahead of other Spans in the Trace. |
| `per_page` | number | No | — | The number of results to return per page. Defaults to 20. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "The ID of the Organization to which the spans belong."
},
"trace_id": {
"type": "string",
"description": "The ID of the Trace to which the spans belong."
},
"from": {
"type": "string",
"description": "Beginning of window to return spans from."
},
"to": {
"type": "string",
"description": "End of window to return spans from."
},
"target_span_id": {
"type": "string",
"description": "The ID of a Span within the Trace to focus on. If provided the target Span and its direct children will be returned ahead of other Spans in the Trace."
},
"per_page": {
"type": "number",
"description": "The number of results to return per page. Defaults to 20."
}
},
"required": [
"PCID",
"organization_id",
"trace_id",
"from",
"to"
]
}
```
***
## bugsnag\_organizations\_list\_organization\_team\_collaborators
List the Collaborators in a Team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | -------------------------------------------------------------- |
| `organization_id` | string | Yes | — | ID of the organization |
| `id` | string | Yes | — | the ID of the team |
| `q` | string | No | — | A partial or full user name or email to filter the results by. |
| `per_page` | number | No | — | Number of results per page |
| `offset` | string | No | — | token to retrieve next page of results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization"
},
"id": {
"type": "string",
"description": "the ID of the team"
},
"q": {
"type": "string",
"description": "A partial or full user name or email to filter the results by."
},
"per_page": {
"type": "number",
"description": "Number of results per page"
},
"offset": {
"type": "string",
"description": "token to retrieve next page of results"
}
},
"required": [
"PCID",
"organization_id",
"id"
]
}
```
***
## bugsnag\_organizations\_list\_organization\_team\_project\_accesses
List Project Access for a Team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | -------------------------------------------------------- |
| `organization_id` | string | Yes | — | ID of the organization |
| `id` | string | Yes | — | the ID of the team |
| `q` | string | No | — | A partial or full project name to filter the results by. |
| `per_page` | number | No | — | Number of results per page |
| `offset` | string | No | — | A token for pagination |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization"
},
"id": {
"type": "string",
"description": "the ID of the team"
},
"q": {
"type": "string",
"description": "A partial or full project name to filter the results by."
},
"per_page": {
"type": "number",
"description": "Number of results per page"
},
"offset": {
"type": "string",
"description": "A token for pagination"
}
},
"required": [
"PCID",
"organization_id",
"id"
]
}
```
***
## bugsnag\_organizations\_list\_organization\_team\_suggested\_collaborators
List Suggested Collaborators to Add to a Team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `organization_id` | string | Yes | — | ID of the organization |
| `id` | string | Yes | — | the ID of the team |
| `q` | string | No | — | A partial or full user name or email to filter the results by. |
| `include_has_access` | boolean | No | — | Request all collaborators in the organization, including those that are not members of the team. By default only collaborators who are not members of the team will be returned. |
| `per_page` | number | No | — | Number of results per page |
| `offset` | string | No | — | token to retrieve next page of results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization"
},
"id": {
"type": "string",
"description": "the ID of the team"
},
"q": {
"type": "string",
"description": "A partial or full user name or email to filter the results by."
},
"include_has_access": {
"type": "boolean",
"description": "Request all collaborators in the organization, including those that are not members of the team. By default only collaborators who are not members of the team will be returned."
},
"per_page": {
"type": "number",
"description": "Number of results per page"
},
"offset": {
"type": "string",
"description": "token to retrieve next page of results"
}
},
"required": [
"PCID",
"organization_id",
"id"
]
}
```
***
## bugsnag\_organizations\_list\_organization\_team\_suggested\_projects
Suggest Projects to Add to a Team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------- | -------- | ------- | ----------------------------------------------------------- |
| `organization_id` | string | Yes | — | ID of the organization |
| `id` | string | Yes | — | the ID of the team |
| `include_has_access` | boolean | No | — | should projects the team already has access to be included? |
| `q` | string | No | — | A partial or full project name to filter the results by. |
| `per_page` | number | No | — | Number of results per page |
| `offset` | string | No | — | token to retrieve next page of results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization"
},
"id": {
"type": "string",
"description": "the ID of the team"
},
"include_has_access": {
"type": "boolean",
"description": "should projects the team already has access to be included?"
},
"q": {
"type": "string",
"description": "A partial or full project name to filter the results by."
},
"per_page": {
"type": "number",
"description": "Number of results per page"
},
"offset": {
"type": "string",
"description": "token to retrieve next page of results"
}
},
"required": [
"PCID",
"organization_id",
"id"
]
}
```
***
## bugsnag\_organizations\_list\_organization\_teams
List Teams from a query
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ----------------------------------------------------- |
| `organization_id` | string | Yes | — | ID of the organization |
| `q` | string | No | — | A partial or full team name to filter the results by. |
| `per_page` | number | No | — | Number of results per page |
| `offset` | string | No | — | Token to retrieve next page of results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization"
},
"q": {
"type": "string",
"description": "A partial or full team name to filter the results by."
},
"per_page": {
"type": "number",
"description": "Number of results per page"
},
"offset": {
"type": "string",
"description": "Token to retrieve next page of results"
}
},
"required": [
"PCID",
"organization_id"
]
}
```
***
## bugsnag\_organizations\_list\_project\_collaborators
List Collaborators on a Project
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------- |
| `project_id` | string | Yes | — | the ID of the project |
| `per_page` | number | No | — | Number of results per page |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "the ID of the project"
},
"per_page": {
"type": "number",
"description": "Number of results per page"
}
},
"required": [
"PCID",
"project_id"
]
}
```
***
## bugsnag\_organizations\_list\_project\_saved\_searches
List Saved Searches on a Project
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------------------------------------------------------------------- |
| `project_id` | string | Yes | — | Project Id |
| `shared` | string | No | — | Limit Saved Searches returned to only those with this `shared` property |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project Id"
},
"shared": {
"type": "string",
"description": "Limit Saved Searches returned to only those with this `shared` property"
}
},
"required": [
"PCID",
"project_id"
]
}
```
***
## bugsnag\_organizations\_list\_user\_organizations
List the Current User's Organizations
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ------------------------------------------------------------------------------- |
| `admin` | boolean | No | — | `true` if only Organizations the Current User is an admin of should be returned |
| `per_page` | number | No | — | Number of results per page |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"admin": {
"type": "boolean",
"description": "`true` if only Organizations the Current User is an admin of should be returned"
},
"per_page": {
"type": "number",
"description": "Number of results per page"
}
},
"required": [
"PCID"
]
}
```
***
## bugsnag\_organizations\_organization\_event\_data\_deletions
Create an event deletion request
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `organization_id` | string | Yes | — | ID of the organization to delete events from |
| `filter_groups` | object | No | — | A map of filter groups, where each group is keyed with a unique identifier for the group e.g: `{ "0": { ... }, "1": { ... } }` See the [Advanced Filters documentation](https://developer.smartbear.com/bugsnag/docs/data-access-filtering#advanced-filters) for more details. |
| `filter_groups_join` | string | No | — | The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied |
| `filters` | object | Yes | — | The filters value |
| `skip_confirmation` | boolean | No | — | whether to skip requiring another request to confirm the deletion |
````json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization to delete events from"
},
"filter_groups": {
"type": "object",
"description": "A map of filter groups, where each group is keyed with a unique identifier for the group e.g: ``` { \"0\": { ... }, \"1\": { ... } } ``` See the [Advanced Filters documentation](https://developer.smartbear.com/bugsnag/docs/data-access-filtering#advanced-filters) for more details."
},
"filter_groups_join": {
"type": "string",
"description": "The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied",
"enum": [
"and",
"or"
]
},
"filters": {
"type": "object",
"description": "The filters value",
"properties": {
"user.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user ids. Matches Errors affecting any of these users. This refers to user ids in the context of your application. Exact match only."
},
"user.email": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of email addresses. Matches Errors that have affected users with email addresses matching any of the provided emails. Supports substring matches."
},
"user.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user names. Matches Errors that have affected users with names matching any of the provided names. Supports substring matches."
},
"error.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error ids. Matches errors with IDs matching any of the given error IDs. Exact match only."
},
"error.status": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error statuses. Matches Errors that have any of the given statuses. Exact match only."
},
"error.assigned_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of collaborator identifiers. Matches Errors that have been assigned to any of the given collaborators. Exact match only. Values can be `me` (for errors assigned to the current user), `anyone` (for errors assigned to anyone), a collaborator ID, or an email address."
},
"error.has_issue": {
"type": "boolean",
"description": "If set to true, matches Errors that have had an issue created for them. If set to false, matches Errors that have not had an issue created for them."
},
"app.release_stage": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of release stages. Matches Errors that have occurred in any of the given release stages. Exact match only."
},
"app.context": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application contexts. This refers to the action that was happening when the event occurred. Matches Errors that occurred in any of the given contexts. Supports substring matches."
},
"app.type": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application types. Matches Errors that occurred in any of the given application types. Exact match only."
},
"version.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred for the first time in any of the given versions. Supports the `?` and `*` wildcards."
},
"version.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred in any of the given versions. Supports the `?` and `*` wildcards."
},
"version_code.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred for the first time in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"version_code.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"release.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred for the first time in any of the given Releases. Supports the `?` and `*` wildcards."
},
"release.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred in any of the given Releases. Supports the `?` and `*` wildcards."
},
"feature_flag.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have been seen with these feature flags (any variant), or the specific variant if specified. When type is `ne`, matches errors that have not been seen with these feature flags or variants. The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"feature_flag.exclusive_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have only been seen with one of these feature flags (any variant), or one of the specific variants if specified. When type is `ne`, matches errors that have been seen with these feature flags or variants but are NOT exclusive to them (i.e., they have also been seen with other feature flags or variants). The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"event.class": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of classes. Matches Errors with any of the given classes. Supports substring matches."
},
"event.message": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of messages. Matches Errors with any of the given messages. Supports substring matches."
},
"event.file": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of file paths. Matches Errors with any of the given files in their stack traces'. Supports substring matches."
},
"event.method": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of method names. Matches Errors with any of the given methods in their stack traces'. Supports substring matches."
},
"event.severity": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of severities. Matches Errors with any of the given severities. Exact match only."
},
"event.since": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring after the given time. Exact match only."
},
"event.before": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring before the given time. Exact match only."
},
"browser.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser names. Matches Errors with events originating from any of the given web browsers. Exact match only."
},
"browser.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser versions. Matches Errors with events originating from any browser with the given version. Exact match only."
},
"os.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system names. Matches Errors with events originating from devices running any of the given operating systems. Exact match only."
},
"os.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system versions. Matches Errors with events originating from devices running any of the given operating system versions. Supports the `?` and `*` wildcards."
},
"device.hostname": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing hostnames. Matches Errors with events occurring on any hosts with one of the given hostnames. Exact match only."
},
"device.manufacturer": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device manufacturer names. Matches Errors with events occurring on any devices made by the given manufacturers. Exact match only."
},
"device.model": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device model names. Matches Errors with events occurring on any of the given device models. Exact match only."
},
"request.url": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of URLs. Matches Errors with events associated with requests to any of the given URLs. Supports substring matches."
},
"request.ip": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of IP addresses. Matches Errors with events affecting any of the given IPs. Exact match only."
},
"device.jailbroken": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring on jailbroken devices."
},
"app.in_foreground": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring when the application was in the foreground."
}
}
},
"skip_confirmation": {
"type": "boolean",
"description": "whether to skip requiring another request to confirm the deletion"
}
},
"required": [
"PCID",
"organization_id",
"filters"
]
}
````
***
## bugsnag\_organizations\_organization\_event\_data\_deletions\_by\_id
Check the status of an event deletion request
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ---------------------------------------------- |
| `organization_id` | string | Yes | — | ID of the organization of the deletion request |
| `id` | string | Yes | — | ID of the deletion request |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization of the deletion request"
},
"id": {
"type": "string",
"description": "ID of the deletion request"
}
},
"required": [
"PCID",
"organization_id",
"id"
]
}
```
***
## bugsnag\_organizations\_organization\_event\_data\_deletions\_confirm
Confirm an event deletion request
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ---------------------------------------------- |
| `organization_id` | string | Yes | — | ID of the organization of the deletion request |
| `id` | string | Yes | — | ID of the deletion request |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization of the deletion request"
},
"id": {
"type": "string",
"description": "ID of the deletion request"
}
},
"required": [
"PCID",
"organization_id",
"id"
]
}
```
***
## bugsnag\_organizations\_organization\_event\_data\_requests
Create an event data request
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `organization_id` | string | Yes | — | ID of the organization to request events for |
| `filter_groups` | object | No | — | A map of filter groups, where each group is keyed with a unique identifier for the group e.g: `{ "0": { ... }, "1": { ... } }` See the [Advanced Filters documentation](https://developer.smartbear.com/bugsnag/docs/data-access-filtering#advanced-filters) for more details. |
| `filter_groups_join` | string | No | — | The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied |
| `filters` | object | Yes | — | The filters value |
| `report_type` | string | No | — | only include event fields that pertain to the user such as event.user, event.device, and event.request; you may need to remove/redact some fields before giving this data to your users that request it |
````json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization to request events for"
},
"filter_groups": {
"type": "object",
"description": "A map of filter groups, where each group is keyed with a unique identifier for the group e.g: ``` { \"0\": { ... }, \"1\": { ... } } ``` See the [Advanced Filters documentation](https://developer.smartbear.com/bugsnag/docs/data-access-filtering#advanced-filters) for more details."
},
"filter_groups_join": {
"type": "string",
"description": "The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied",
"enum": [
"and",
"or"
]
},
"filters": {
"type": "object",
"description": "The filters value",
"properties": {
"user.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user ids. Matches Errors affecting any of these users. This refers to user ids in the context of your application. Exact match only."
},
"user.email": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of email addresses. Matches Errors that have affected users with email addresses matching any of the provided emails. Supports substring matches."
},
"user.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user names. Matches Errors that have affected users with names matching any of the provided names. Supports substring matches."
},
"error.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error ids. Matches errors with IDs matching any of the given error IDs. Exact match only."
},
"error.status": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error statuses. Matches Errors that have any of the given statuses. Exact match only."
},
"error.assigned_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of collaborator identifiers. Matches Errors that have been assigned to any of the given collaborators. Exact match only. Values can be `me` (for errors assigned to the current user), `anyone` (for errors assigned to anyone), a collaborator ID, or an email address."
},
"error.has_issue": {
"type": "boolean",
"description": "If set to true, matches Errors that have had an issue created for them. If set to false, matches Errors that have not had an issue created for them."
},
"app.release_stage": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of release stages. Matches Errors that have occurred in any of the given release stages. Exact match only."
},
"app.context": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application contexts. This refers to the action that was happening when the event occurred. Matches Errors that occurred in any of the given contexts. Supports substring matches."
},
"app.type": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application types. Matches Errors that occurred in any of the given application types. Exact match only."
},
"version.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred for the first time in any of the given versions. Supports the `?` and `*` wildcards."
},
"version.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred in any of the given versions. Supports the `?` and `*` wildcards."
},
"version_code.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred for the first time in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"version_code.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"release.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred for the first time in any of the given Releases. Supports the `?` and `*` wildcards."
},
"release.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred in any of the given Releases. Supports the `?` and `*` wildcards."
},
"feature_flag.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have been seen with these feature flags (any variant), or the specific variant if specified. When type is `ne`, matches errors that have not been seen with these feature flags or variants. The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"feature_flag.exclusive_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have only been seen with one of these feature flags (any variant), or one of the specific variants if specified. When type is `ne`, matches errors that have been seen with these feature flags or variants but are NOT exclusive to them (i.e., they have also been seen with other feature flags or variants). The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"event.class": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of classes. Matches Errors with any of the given classes. Supports substring matches."
},
"event.message": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of messages. Matches Errors with any of the given messages. Supports substring matches."
},
"event.file": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of file paths. Matches Errors with any of the given files in their stack traces'. Supports substring matches."
},
"event.method": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of method names. Matches Errors with any of the given methods in their stack traces'. Supports substring matches."
},
"event.severity": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of severities. Matches Errors with any of the given severities. Exact match only."
},
"event.since": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring after the given time. Exact match only."
},
"event.before": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring before the given time. Exact match only."
},
"browser.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser names. Matches Errors with events originating from any of the given web browsers. Exact match only."
},
"browser.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser versions. Matches Errors with events originating from any browser with the given version. Exact match only."
},
"os.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system names. Matches Errors with events originating from devices running any of the given operating systems. Exact match only."
},
"os.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system versions. Matches Errors with events originating from devices running any of the given operating system versions. Supports the `?` and `*` wildcards."
},
"device.hostname": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing hostnames. Matches Errors with events occurring on any hosts with one of the given hostnames. Exact match only."
},
"device.manufacturer": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device manufacturer names. Matches Errors with events occurring on any devices made by the given manufacturers. Exact match only."
},
"device.model": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device model names. Matches Errors with events occurring on any of the given device models. Exact match only."
},
"request.url": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of URLs. Matches Errors with events associated with requests to any of the given URLs. Supports substring matches."
},
"request.ip": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of IP addresses. Matches Errors with events affecting any of the given IPs. Exact match only."
},
"device.jailbroken": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring on jailbroken devices."
},
"app.in_foreground": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring when the application was in the foreground."
}
}
},
"report_type": {
"type": "string",
"description": "only include event fields that pertain to the user such as event.user, event.device, and event.request; you may need to remove/redact some fields before giving this data to your users that request it",
"enum": [
"gdpr"
]
}
},
"required": [
"PCID",
"organization_id",
"filters"
]
}
````
***
## bugsnag\_organizations\_organization\_event\_data\_requests\_by\_id
Check the status of an event data request
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------ |
| `organization_id` | string | Yes | — | ID of the organization of the event data request |
| `id` | string | Yes | — | ID of the event data request |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization of the event data request"
},
"id": {
"type": "string",
"description": "ID of the event data request"
}
},
"required": [
"PCID",
"organization_id",
"id"
]
}
```
***
## bugsnag\_organizations\_revoke\_organization\_api\_key
Regenerate an Organization's API key
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ---------------------- |
| `id` | string | Yes | — | ID of the organization |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "ID of the organization"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## bugsnag\_organizations\_revoke\_organization\_auth\_token
Regenerate an Organization's auth token
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ---------------------- |
| `id` | string | Yes | — | ID of the organization |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "ID of the organization"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## bugsnag\_organizations\_update\_organization\_by\_id
Update an Organization
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | the ID of the organization |
| `auto_upgrade` | boolean | Yes | — | whether we should upgrade your plan in response to the organization reaching its plan limit of events. If this value is `false` your events will be throttled when you reach your plan limit. |
| `billing_emails` | string\[] | No | — | Billing Emails |
| `invoice_address` | string | No | — | Additional information to print on your invoice |
| `invoice_info` | string | No | — | Deprecated field. Use `invoice_address` |
| `name` | string | Yes | — | The name value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "the ID of the organization"
},
"auto_upgrade": {
"type": "boolean",
"description": "whether we should upgrade your plan in response to the organization reaching its plan limit of events. If this value is `false` your events will be throttled when you reach your plan limit."
},
"billing_emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Billing Emails"
},
"invoice_address": {
"type": "string",
"description": "Additional information to print on your invoice"
},
"invoice_info": {
"type": "string",
"description": "Deprecated field. Use `invoice_address`"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID",
"id",
"auto_upgrade",
"name"
]
}
```
***
## bugsnag\_organizations\_update\_organization\_collaborator
Update a Collaborator's permissions
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `organization_id` | string | Yes | — | the ID of your organization |
| `id` | string | Yes | — | the ID of the collaborator to update |
| `admin` | boolean | No | — | Whether to give admin permissions to the user. |
| `project_ids` | string\[] | No | — | The ids of projects in the current organization that the invited user should have access to. |
| `project_roles` | object | No | — | The IDs of the projects to which the user should have access, and the roles they should have, either 'project\_owner' or 'project\_member'. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "the ID of your organization"
},
"id": {
"type": "string",
"description": "the ID of the collaborator to update"
},
"admin": {
"type": "boolean",
"description": "Whether to give admin permissions to the user."
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ids of projects in the current organization that the invited user should have access to."
},
"project_roles": {
"type": "object",
"description": "The IDs of the projects to which the user should have access, and the roles they should have, either 'project_owner' or 'project_member'."
}
},
"required": [
"PCID",
"organization_id",
"id"
]
}
```
***
## bugsnag\_organizations\_update\_organization\_team
Update a team name
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | -------------------------------- |
| `organization_id` | string | Yes | — | ID of the organization |
| `id` | string | Yes | — | the ID of the team to be deleted |
| `name` | string | Yes | — | The name value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization"
},
"id": {
"type": "string",
"description": "the ID of the team to be deleted"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID",
"organization_id",
"id",
"name"
]
}
```
***
## bugsnag\_organizations\_update\_organization\_team\_project\_accesses
Add Project Access to a Team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `organization_id` | string | Yes | — | ID of the organization |
| `id` | string | Yes | — | the ID of the team |
| `add_all_projects` | boolean | No | — | Whether to add all remaining projects to the team. If `true`, `project_role` must also be supplied. User making the request must be an organization administrator if using `true`. |
| `project_role` | string | No | — | Project Role |
| `project_roles` | object | No | — | A map of project IDs to the roles to be assigned to them. Must be `project_owner` unless the organization has access to the `enterprise-roles` feature. Cannot be supplied if `add_all_projects` is `true`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization"
},
"id": {
"type": "string",
"description": "the ID of the team"
},
"add_all_projects": {
"type": "boolean",
"description": "Whether to add all remaining projects to the team. If `true`, `project_role` must also be supplied. User making the request must be an organization administrator if using `true`."
},
"project_role": {
"type": "string",
"description": "Project Role",
"enum": [
"project_owner",
"project_member"
]
},
"project_roles": {
"type": "object",
"description": "A map of project IDs to the roles to be assigned to them. Must be `project_owner` unless the organization has access to the `enterprise-roles` feature. Cannot be supplied if `add_all_projects` is `true`.",
"properties": {
"515fb9337c1074f6fd000002": {
"type": "string",
"description": "The 515fb9337c1074f6fd000002 value",
"enum": [
"project_owner",
"project_member"
]
}
},
"required": [
"515fb9337c1074f6fd000002"
]
}
},
"required": [
"PCID",
"organization_id",
"id"
]
}
```
***
## bugsnag\_organizations\_update\_saved\_search\_by\_id
Update a Saved Search
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------- | -------- | ------- | --------------------------------------------------------------------- |
| `id` | string | Yes | — | The ID of the saved search |
| `filters` | object | No | — | The filters value |
| `name` | string | No | — | name of the saved search |
| `project_default` | boolean | No | — | whether this saved search is the project default for the current user |
| `shared` | boolean | No | — | whether this saved search is shared among collaborators |
| `sort` | string | No | — | Sort order for results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of the saved search"
},
"filters": {
"type": "object",
"description": "The filters value",
"properties": {
"user.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user ids. Matches Errors affecting any of these users. This refers to user ids in the context of your application. Exact match only."
},
"user.email": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of email addresses. Matches Errors that have affected users with email addresses matching any of the provided emails. Supports substring matches."
},
"user.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user names. Matches Errors that have affected users with names matching any of the provided names. Supports substring matches."
},
"error.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error ids. Matches errors with IDs matching any of the given error IDs. Exact match only."
},
"error.status": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error statuses. Matches Errors that have any of the given statuses. Exact match only."
},
"error.assigned_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of collaborator identifiers. Matches Errors that have been assigned to any of the given collaborators. Exact match only. Values can be `me` (for errors assigned to the current user), `anyone` (for errors assigned to anyone), a collaborator ID, or an email address."
},
"error.has_issue": {
"type": "boolean",
"description": "If set to true, matches Errors that have had an issue created for them. If set to false, matches Errors that have not had an issue created for them."
},
"app.release_stage": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of release stages. Matches Errors that have occurred in any of the given release stages. Exact match only."
},
"app.context": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application contexts. This refers to the action that was happening when the event occurred. Matches Errors that occurred in any of the given contexts. Supports substring matches."
},
"app.type": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application types. Matches Errors that occurred in any of the given application types. Exact match only."
},
"version.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred for the first time in any of the given versions. Supports the `?` and `*` wildcards."
},
"version.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred in any of the given versions. Supports the `?` and `*` wildcards."
},
"version_code.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred for the first time in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"version_code.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"release.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred for the first time in any of the given Releases. Supports the `?` and `*` wildcards."
},
"release.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred in any of the given Releases. Supports the `?` and `*` wildcards."
},
"feature_flag.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have been seen with these feature flags (any variant), or the specific variant if specified. When type is `ne`, matches errors that have not been seen with these feature flags or variants. The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"feature_flag.exclusive_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have only been seen with one of these feature flags (any variant), or one of the specific variants if specified. When type is `ne`, matches errors that have been seen with these feature flags or variants but are NOT exclusive to them (i.e., they have also been seen with other feature flags or variants). The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"event.class": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of classes. Matches Errors with any of the given classes. Supports substring matches."
},
"event.message": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of messages. Matches Errors with any of the given messages. Supports substring matches."
},
"event.file": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of file paths. Matches Errors with any of the given files in their stack traces'. Supports substring matches."
},
"event.method": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of method names. Matches Errors with any of the given methods in their stack traces'. Supports substring matches."
},
"event.severity": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of severities. Matches Errors with any of the given severities. Exact match only."
},
"event.since": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring after the given time. Exact match only."
},
"event.before": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring before the given time. Exact match only."
},
"browser.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser names. Matches Errors with events originating from any of the given web browsers. Exact match only."
},
"browser.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser versions. Matches Errors with events originating from any browser with the given version. Exact match only."
},
"os.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system names. Matches Errors with events originating from devices running any of the given operating systems. Exact match only."
},
"os.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system versions. Matches Errors with events originating from devices running any of the given operating system versions. Supports the `?` and `*` wildcards."
},
"device.hostname": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing hostnames. Matches Errors with events occurring on any hosts with one of the given hostnames. Exact match only."
},
"device.manufacturer": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device manufacturer names. Matches Errors with events occurring on any devices made by the given manufacturers. Exact match only."
},
"device.model": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device model names. Matches Errors with events occurring on any of the given device models. Exact match only."
},
"request.url": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of URLs. Matches Errors with events associated with requests to any of the given URLs. Supports substring matches."
},
"request.ip": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of IP addresses. Matches Errors with events affecting any of the given IPs. Exact match only."
},
"device.jailbroken": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring on jailbroken devices."
},
"app.in_foreground": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring when the application was in the foreground."
}
}
},
"name": {
"type": "string",
"description": "name of the saved search"
},
"project_default": {
"type": "boolean",
"description": "whether this saved search is the project default for the current user"
},
"shared": {
"type": "boolean",
"description": "whether this saved search is shared among collaborators"
},
"sort": {
"type": "string",
"description": "Sort order for results",
"enum": [
"first_seen",
"users",
"events",
"last_seen"
]
}
},
"required": [
"PCID",
"id"
]
}
```