Connections

List reachable connections

Lists every connection the caller's grant reaches - the connections it can read plus the ones it can only run a custom action on - each labelled with the access it confers. A connection the grant cannot read carries only its key, connector and access label, never the connection record.

get/v1/connections/reachable

Request

  • Base URL: https://api.withone.ai
  • URL: https://api.withone.ai/v1/connections/reachable
  • Auth: one of:
    • HTTP bearer
    • Session (a scheme the document does not define)
    • 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

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.

X-One-Project-Idstring uuid

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

Response

Paginated reachable connections, each with its access label

pageinteger required
pagesinteger required
totalinteger required

Changes

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