Sign in
External Accounts

List External Account Partners

Changed on

Lists the creators an Instagram account runs partnership ads with, and where each creator's permission stands.

get/external_accounts/{external_account_id}/partners

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/external_accounts/{external_account_id}/partners
  • Auth: HTTP bearer

Query parameters

account_idstring

The Account (biz_ identifier) that advertises as the Instagram account. An account-scoped API key may omit this to default to its own account.

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.

Response

partners listed

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