Accounts
List Connections
Lists the workspace's connections, newest first. Results are paginated.
x-api-key<token>Workspace API key, sent in the x-api-key header. Keys start with op_ and are created in the dashboard.
limit?integerConnections per page. Defaults to 500. Maximum 500.
1 <= value <= 500page?integerPage to return, starting at 1. Defaults to 1.
1 <= valueq?stringSearches display name, handle and platform. Matching ignores case.
length <= 200profile?stringReturns only accounts filed under this profile name. An unknown name matches nothing.
length <= 60platform?stringReturns only accounts on this platform.
length <= 64addedWithinDays?integerReturns only accounts connected within the last N days.
0 < value <= 3650sort?stringSort order. Defaults to newest.
"newest""oldest"Connected accounts
application/json- response
connections*array<>total*integerNumber of connections that match the filters, across all pages.
page*integerThe page number of this response, starting at 1.
hasMore*booleanTrue when more connections follow this page. Request the next page while it is true.
import { Configuration, ConnectionsApi } from "@onepostly/sdk";const connectionsApi = new ConnectionsApi( new Configuration({ apiKey: process.env.ONEPOSTLY_API_KEY }));const response = await connectionsApi.listConnections({ limit: 20, page: 2, profile: "Business", platform: "instagram", addedWithinDays: 90, sort: "newest",});console.log(response);{ "connections": [ { "id": "a1b2c3d4-e5f6-4a7b-8c9d-e0f1a2b3c4d5", "platform": "instagram", "displayName": "Onepostly", "handle": "@onepostly", "avatarUrl": "https://cdn.onepostly.com/avatars/onepostly.jpg", "status": "active", "tokenExpiresAt": "2026-10-25T10:00:00.000Z", "canAutoRenew": true, "authHealth": "healthy", "profileName": "Business", "xSubscriptionType": "Premium", "createdAt": "2026-08-25T10:00:00.000Z", "updatedAt": "2026-08-25T10:00:00.000Z" } ], "total": 2000, "page": 1, "hasMore": true}