Sign in
External Accounts

List External Accounts

Changed on

Lists the external accounts linked to an account or user.

get/external_accounts

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/external_accounts
  • Auth: HTTP bearer

Query parameters

account_idstring

The Account that the external accounts are connected to. Provide either this or user_id.

user_idstring

The User that the external accounts are connected to. Provide either this or account_id.

platform'x' | 'instagram' | 'youtube' | 'tiktok' | 'facebook' | 'discord' | 'telegram' | 'linkedin' | 'snapchat'

Only return external accounts for the platform that is specified.

trust_level'oauth' | 'verified' | 'authorized' | 'claimed' | 'scraped'

Only return external accounts linked with this trust level, such as oauth for accounts connected through OAuth.

verifiedboolean

Only return external accounts that are verified on the platform.

scopesstring[]

Only return external accounts that have these scopes.

firstinteger

Number of results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

lastinteger

Number of results to return from the end of the range.

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

order'display_order' | 'created_at'

The field to sort external accounts by.

direction'asc' | 'desc'

Sort direction.

Response

filtered to accounts holding the requested scope

Example response

{
  "data": [
    {
      "error": "You don't have permission to share this account. Ask an admin of its Meta Business Portfolio to grant you full control, then share it again.",
      "external_id": "1234567891",
      "id": "sacc_xxxxxxxxxxxxxx",
      "name": "Shine Time Auto Detailing",
      "parent_external_account": {
        "external_id": "555111",
        "id": "sacc_xxxxxxxxxxxxxx",
        "name": "Shine Time Auto Detailing",
        "platform": "facebook",
        "profile_picture_url": "https://shinetime.example/logo.png",
        "username": "shinetimedetailing",
        "verified": true
      },
      "partnership_status": "pending",
      "platform": "instagram",
      "profile_picture_url": "https://shinetime.example/logo.png",
      "scopes": [
        "advertise"
      ],
      "url": "https://instagram.com/shinetimedetail",
      "username": "shinetimedetail",
      "verified": true
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes