List

Retrieve a paginated list of social accounts connected to your project, with filtering and search.

Endpoint

GET https://api.postpeer.dev/v1/connect/integrations

Query Parameters

Parameter	Type	Default	Description
`platform`	string	—	Filter by platform (e.g. `twitter`, `instagram`, `youtube`, `tiktok`, `pinterest`, `linkedin`, `bluesky`, `facebook`, `threads`)
`profileId`	string	—	Filter to integrations bound to this profile. Pass `null` (literal string) to filter to integrations with no profile.
`q`	string	—	Case-insensitive search across `displayName` and `platformUserId`
`limit`	integer	`20`	Page size (1–100)
`offset`	integer	`0`	Number of integrations to skip
`sort`	string	`"desc"`	Sort by `createdAt`: `"asc"` or `"desc"`

Example

curl "https://api.postpeer.dev/v1/connect/integrations?platform=twitter&limit=10" \
  -H "x-access-key: YOUR_API_KEY"

Response

{
  "success": true,
  "total": 42,
  "integrations": [
    {
      "id": "abc123",
      "platform": "twitter",
      "platformUserId": "123456789",
      "displayName": "@yourhandle",
      "imageUrl": "https://pbs.twimg.com/profile_images/.../photo.jpg",
      "profileId": null,
      "createdAt": "2026-03-28T10:00:00.000Z"
    },
    {
      "id": "def456",
      "platform": "youtube",
      "platformUserId": "UCxxxxxxxx",
      "displayName": "My Channel",
      "imageUrl": "https://yt3.ggpht.com/.../photo.jpg",
      "profileId": "profile_acme",
      "createdAt": "2026-03-28T10:05:00.000Z"
    }
  ]
}

total is the total number of integrations matching the filter (across all pages). Walk the result set by incrementing offset by limit until you've fetched total items.

Response Fields

Field	Type	Description
`id`	string	Integration ID — use this as `accountId` when creating posts
`platform`	string	Platform name
`platformUserId`	string \| null	The user/account ID on the platform
`displayName`	string \| null	Display name or handle
`imageUrl`	string \| null	Profile image URL
`profileId`	string \| null	Profile this integration belongs to, if any
`createdAt`	string	ISO 8601 connection timestamp

Status Codes

Code	Meaning
`200`	Success
`400`	Invalid query parameters