Skip to content
PostyAPIv0.3.81
Menu

API reference

Channels

List channels

get/v1/channels

List connected social channels in the selected workspace with optional provider and status filters and cursor pagination. Returns stored account details and channel IDs for composing posts, without contacting social platforms.

Query parameters

  • workspaceIdstring

    Min length 1

  • limitinteger

    Default 20 · Min 1 · Max 100

  • starting_afterstring
  • ending_beforestring
  • providerstring

    One ofblueskydiscordfacebookinstagramlinkedinpinterestthreadstiktokwordpressyoutube

  • statusstring

    One ofpendingactiveerrordisconnected

Response 200

List of channels

  • objectstringrequired

    One oflist

  • dataarray of Channelrequired
  • has_morebooleanrequired
  • next_cursorstringrequirednullable

Errors

401
Unauthenticated
403
Missing scope
Request
curl "https://api.posty.social/v1/channels" \
  -H "Authorization: Bearer $POSTY_API_KEY"
Response 200
{
  "object": "list",
  "data": [
    {
      "id": "string",
      "workspaceId": "string",
      "provider": "bluesky",
      "providerAccountId": "string",
      "name": "string",
      "accountLabel": "string",
      "avatarUrl": "string",
      "status": "pending",
      "missingPermissions": [
        "read_insights"
      ],
      "connectedByUserId": "string",
      "createdAt": "2026-01-15T09:30:00.000Z",
      "updatedAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

Get channel

get/v1/channels/{id}

Retrieve a connected social channel by ID in the selected workspace. Returns stored account, provider and connection-status details without credentials or a live request to the social platform.

Path parameters

  • idstringrequired

Response 200

Channel

  • idstringrequired
  • workspaceIdstringrequired
  • providerstringrequired

    One ofblueskydiscordfacebookinstagramlinkedinpinterestthreadstiktokwordpressyoutube

  • providerAccountIdstringrequired
  • namestringrequired
  • accountLabelstringrequirednullable
  • avatarUrlstringrequirednullable
  • statusstringrequired

    One ofpendingactiveerrordisconnected

  • missingPermissionsarray of stringrequired

    Permissions the connection lacks, as the platform names them. Features that need them stop working until the channel is reconnected with every permission allowed.

  • connectedByUserIdstringrequirednullable
  • createdAtstring (date-time)required
  • updatedAtstring (date-time)required

Errors

401
Unauthenticated
403
Missing scope
404
Not found
Request
curl "https://api.posty.social/v1/channels/$ID" \
  -H "Authorization: Bearer $POSTY_API_KEY"
Response 200
{
  "id": "string",
  "workspaceId": "string",
  "provider": "bluesky",
  "providerAccountId": "string",
  "name": "string",
  "accountLabel": "string",
  "avatarUrl": "string",
  "status": "pending",
  "missingPermissions": [
    "read_insights"
  ],
  "connectedByUserId": "string",
  "createdAt": "2026-01-15T09:30:00.000Z",
  "updatedAt": "2026-01-15T09:30:00.000Z"
}

Models

Objects referenced by the endpoints above.

Channel

  • idstringrequired
  • workspaceIdstringrequired
  • providerstringrequired

    One ofblueskydiscordfacebookinstagramlinkedinpinterestthreadstiktokwordpressyoutube

  • providerAccountIdstringrequired
  • namestringrequired
  • accountLabelstringrequirednullable
  • avatarUrlstringrequirednullable
  • statusstringrequired

    One ofpendingactiveerrordisconnected

  • missingPermissionsarray of stringrequired

    Permissions the connection lacks, as the platform names them. Features that need them stop working until the channel is reconnected with every permission allowed.

  • connectedByUserIdstringrequirednullable
  • createdAtstring (date-time)required
  • updatedAtstring (date-time)required