List vault connections
Returns the connections you have access to. The result is filtered to your scope automatically — your own connections, your organization's, or your project's, depending on the key you use. Filter further by platform, identity, key, or tags.
Request
- Base URL: https://api.withone.ai
- URL: https://api.withone.ai/v1/vault/connections
- Auth: one of:
- API key in header X-One-Secret
- OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: user:connections:read)
- OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: org:connections:read)
- OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: project:connections:read)
Query parameters
Filter by the upstream platform identity (e.g. the user's email or remote account id) the connection authenticates as.
Restrict the result to connections of the given identity type (user, account, workspace, etc.).
Filter by platform identifier (e.g. gmail, shopify).
Filter by exact connection key. Accepts a single key or a comma-separated list.
Filter by tags attached to the connection. Accepts a single tag or a comma-separated list.
Items per page. Default 20, hard-capped at 150. limit=0 is treated as 1. Larger values silently clamp.
Page number for pagination (1-indexed). Defaults to 1.
Number of items to skip before the first returned item. Defaults to 0. Most callers should leave this at 0 and rely on page + limit.
Headers
Selects the tenant this request acts in. Omit it to act in your personal scope.
Selects the tenant this request acts in. Omit it to act in your personal scope.
Response
Paginated list of vault connections
Changes
No recorded changes to this operation across all 1 revision of this API.