Connections

Get user connections with pagination

get

Get User Connections

Retrieve user connections with comprehensive pagination, filtering, and sorting support.

Usage Examples

Basic pagination

GET /v1/connections - First page with default settings

GET /v1/connections?page=2&limit=10 - Second page, 10 items per page

Sorting

GET /v1/connections?sortBy=updatedAt&sortOrder=desc - Sort by last update (newest first)

GET /v1/connections?sortBy=createdAt&sortOrder=asc - Sort by creation date (oldest first)

Filtering

GET /v1/connections?status=active - Show only active connections

GET /v1/connections?status=expired - Show only expired connections

Combined queries

GET /v1/connections?page=2&limit=50&status=active&sortBy=updatedAt&sortOrder=desc

Required scope: connections Access restriction: BlueNexus frontend OR whitelabel customer client only

Authorizations

access-token

AuthorizationstringRequired

Enter JWT access token

Query parameters

filterstringOptional

MongoDB-style filter object (passed as URL-encoded JSON string). Only allows filtering by safe, non-sensitive fields: status, providerId, and date ranges. Strict validation prevents abuse.

Example: {"value":"{\"status\":\"active\"}","description":"Filter by connection status (active|expired|revoked|error)"}

pagenumber · min: 1Optional

Page number (1-based)

Default: 1Example: 1

limitnumber · min: 1 · max: 100Optional

Number of connections to return (1-100)

Default: 20Example: 20

sortBystring · enumOptional

Field to sort by

Default: createdAtExample: createdAtPossible values:

sortOrderstring · enumOptional

Sort order

Default: descExample: descPossible values:

Responses

200

Paginated list of user connections with status information

application/json

500

Internal server error

application/json

get

/api/v1/connections

HTTPcURLJavaScriptPython

GET /api/v1/connections HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    []
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "pages": 10,
    "hasNext": true,
    "hasPrev": false
  }
}

Get connection details

get

Get connection details.

Required scope: connections Access restriction: BlueNexus frontend OR whitelabel customer client only

Authorizations

access-token

AuthorizationstringRequired

Enter JWT access token

Path parameters

connectionIdstringRequired

Connection ID

Responses

200

Connection details

application/json

500

Internal server error

application/json

get

/api/v1/connections/{connectionId}

HTTPcURLJavaScriptPython

GET /api/v1/connections/{connectionId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "accountId": "text",
  "providerId": "text",
  "providerUserId": "text",
  "scopes": [
    "text"
  ],
  "status": "active",
  "expiresAt": "2026-01-08T00:58:07.851Z",
  "metadata": {},
  "createdAt": "2026-01-08T00:58:07.851Z",
  "updatedAt": "2026-01-08T00:58:07.851Z",
  "canRefresh": true
}