Vault

List organization vault connections

Returns the connections inside an organization. Useful when an admin needs to see every connection across the org regardless of which project they're signed into. Filter by platform, identity, key, or tags.

get/v1/vault/organizations/{org_id}/connections

Request

  • Base URL: https://api.withone.ai
  • URL: https://api.withone.ai/v1/vault/organizations/{org_id}/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: org:connections:read)

Path parameters

org_idstring uuid required

Organization ID

Query parameters

identitystring

Filter by the upstream platform identity (e.g. the user's email or remote account id) the connection authenticates as.

identityType'organization' | 'user' | 'team' | 'project'

Restrict the result to connections of the given identity type (user, account, workspace, etc.).

platformstring

Filter by platform identifier (e.g. gmail, shopify).

keystring

Filter by exact connection key. Accepts a single key or a comma-separated list.

tagsstring

Filter by tags attached to the connection. Accepts a single tag or a comma-separated list.

limitinteger

Items per page. Default 20, hard-capped at 150. limit=0 is treated as 1. Larger values silently clamp.

pageinteger

Page number for pagination (1-indexed). Defaults to 1.

skipinteger

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

X-One-Organization-Idstring uuid

Selects the tenant this request acts in. Omit it to act in your personal scope.

Response

Paginated list of organization vault connections

pageinteger required
pagesinteger required
totalinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.