latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

WorkspaceIntegration

Query Workspace Integrations

Query matching Integration Configurations for Workspace

get/workspaces/{workspace_id}/integrations

Path parameters

workspace_idstring required

workspace id

Query parameters

integration_type'atlassian_connect' | 'atlassian_rovo' | 'export_feed_google_bigquery' | 'export_feed_google_cloud_storage' | 'export_feed_google_pubsub' | 'github_app' | 'jira' | 'jira_server_plugin' | 'microsoft_teams_webhook' | 'segment' | 'slack' | 'xray' | 'xray_sync'

integration type filter

oauth_token_idstring

Return only if has a matching OAuth token id

user_idstring

Return only if has a matching user id

enabledboolean

Return only enabled or disabled integrations

limitinteger

The limit to use for pagination

cursorstring

The cursor to use for pagination

integration_typesIntegrationTypeEnum[]

Multiple integration types filter. Will be used only integration_type is not provided

with_secretsboolean

Return decrypted secrets if true

renew_secretsboolean

Renew time sensitive secrets, if relevant to the given integration, and IFF with_secrets is true

Response

Workspace Integrations, if any

cursorstring

Cursor used for pagination

Example response

{
  "integrations": [
    {
      "config": {
        "issue_tracker": {
          "base_url": "https://jira.example.com/jira",
          "schemas": [
            {
              "fields": [
                {
                  "id": "affected_platform",
                  "name": "Affected Platform",
                  "type": "labels",
                  "allowed_values": [
                    {
                      "value": "Chrome"
                    },
                    {
                      "value": "Edge"
                    },
                    {
                      "value": "Firefox"
                    },
                    {
                      "value": "IE11"
                    },
                    {
                      "value": "Safari"
                    }
                  ],
                  "is_required": true
                }
              ]
            }
          ]
        }
      }
    }
  ]
}