---
title: "Execute a typed, bounded read against a Banger-managed connection."
method: POST
path: "/v1/workspaces/{workspaceId}/connections/{connectionId}/query"
---

# Execute a typed, bounded read against a Banger-managed connection.

`POST /v1/workspaces/{workspaceId}/connections/{connectionId}/query`

## Request

- Base URL: `https://api.bangermail.com`
- URL: `https://api.bangermail.com/v1/workspaces/{workspaceId}/connections/{connectionId}/query`
- Auth: HTTP bearer

## Request body

- ConnectionQueryRequest
  - `adapter_key` 'figma' | 'github' | 'google-analytics' | 'google-calendar' | 'hubspot' | 'linear' | 'mailchimp' | 'notion' | 'slack' | 'snowflake' | 'zendesk', required
  - `operation` 'audiences.list' | 'blocks.children.list' | 'campaigns.list' | 'changelog.brief' | 'channels.list' | 'comments.list' | 'commits.list' | 'companies.list' | 'contacts.list' | 'cohorts.list' | 'customer.brief' | 'customers.list' | 'deals.list' | 'events.list' | 'file.summary' | 'funnels.list' | 'images.render' | 'invoices.list' | 'issues.list' | 'launch.brief' | 'messages.history' | 'messages.search' | 'nodes.get' | 'notifications.list' | 'pages.retrieve' | 'payment_intents.list' | 'persons.list' | 'profiles.list' | 'queries.execute' | 'queries.list' | 'releases.list' | 'reports.list' | 'reports.run' | 'repositories.list' | 'search.list' | 'subscriptions.list', required
  - `parameters` object

## Response `200`

An authenticated, typed response from the connected source.

- object
  - `data` ConnectionQueryResult, required
    - `adapter_key` 'figma' | 'github' | 'google-analytics' | 'google-calendar' | 'hubspot' | 'linear' | 'mailchimp' | 'notion' | 'slack' | 'snowflake' | 'zendesk', required
    - `operation` string, required
    - `capability` string, required
    - `source` object, required
      - `external_account_id` string, required
      - `external_account_name` string, required
      - `fetched_at` string, date-time, required
      - `freshness` 'live', required
    - `data` object, required

## Other responses

- `403`: The API key has no matching connection grant.

---

[API](https://skmtc.dev/bangermail/apis/banger-api.md) · [All operations](https://skmtc.dev/bangermail/apis/banger-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bangermail/apis/banger-api/revisions/a149909267f9?raw)
