> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages.
> MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md
> Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Agent mode: https://docs.whop.com/cli/agent-mode.md
> Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Every agent tool: https://docs.whop.com/developer/ai/overview.md
> Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Comparison: https://docs.whop.com/developer/quickstart.md
> API: send `Authorization: Bearer <API_KEY>` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json
> Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only.

# External Account

> An External Account represents an account on another platform linked to a Whop account or user, such as a Facebook page, Instagram account, TikTok account, or Klaviyo account. You connect it through OAuth or an API key, or Whop creates it for you. External account IDs are prefixed `sacc_`.

Use the External Accounts API to list connected accounts, [connect a profile through OAuth](https://docs.whop.com/api-reference/external-accounts/connect-an-external-account.md), [create a Whop-managed Facebook page or TikTok account, or connect a Klaviyo account with its API key](https://docs.whop.com/api-reference/external-accounts/create-an-external-account.md), and disconnect an external account.

## Endpoints

| Endpoint | Request |
| - | - |
| [List External Accounts](https://docs.whop.com/api-reference/external-accounts/list-external-accounts.md) | GET `/external_accounts` |
| [Create an External Account](https://docs.whop.com/api-reference/external-accounts/create-an-external-account.md) | POST `/external_accounts` |
| [Refresh](https://docs.whop.com/api-reference/external-accounts/refresh.md) | POST `/external_accounts/{id}/refresh` |
| [Connect an External Account](https://docs.whop.com/api-reference/external-accounts/connect-an-external-account.md) | POST `/external_accounts/connect` |
| [Delete an External Account](https://docs.whop.com/api-reference/external-accounts/delete-an-external-account.md) | DELETE `/external_accounts/{id}` |

## Attributes

**id** `string` *required*

Unique identifier for the external account.

**error** `string | null` *required*

Why this external account currently can't be used for advertising — a failed
share or a Meta-side restriction. Null when the account is healthy.

**external\_id** `string | null` *required*

The platform-specific ID for this external account.

**name** `string | null` *required*

The display name of the external account on the platform.

**parent\_external\_account** `object | null` *required*

The external account this one belongs to on the platform, such as the Facebook page that owns an Instagram account. Null when the external account stands on its own, or when it is a partner.

> [accordion] Properties
>
> **id** `string` *required*
>
> External account ID, prefixed `sacc_`.
>
> **external\_id** `string | null` *required*
>
> The platform-specific ID for the parent external account.
>
> **name** `string | null` *required*
>
> The display name of the parent external account on the platform.
>
> **platform** `string` *required*
>
> The platform the parent external account exists on.
>
> Available options: `x`, `instagram`, `youtube`, `tiktok`, `facebook`, `linkedin`, `snapchat`, `klaviyo`, `quickbooks`, `aimerce`
>
> **profile\_picture\_url** `string | null` *required*
>
> The URL where the profile picture of the parent external account can be
> accessed.
>
> **username** `string | null` *required*
>
> The username of the parent external account on the platform.
>
> **verified** `boolean` *required*
>
> Whether the parent external account is verified on the platform.

**partnership\_status** `string | null` *required*

Always `null`. Partnership ads are no longer available.

**platform** `string` *required*

The platform the external account exists on.

Available options: `x`, `instagram`, `youtube`, `tiktok`, `facebook`, `linkedin`, `snapchat`, `klaviyo`, `quickbooks`, `aimerce`

**profile\_picture\_url** `string | null` *required*

The URL where the profile picture of the external account can be accessed.

**scopes** `string[]` *required*

Capabilities Whop retains specific to this external account. For example, Whop
may request the ability to run advertisements that use this external account's
identity, reflected by `advertise`. Personal profile connections have no
additional Whop scopes.

**url** `string | null` *required*

The URL where the external account can be accessed on the platform. Null while
a Whop-owned account is still being provisioned.

**username** `string | null` *required*

The username of the external account on the platform. Null while a Whop-owned
account is still being provisioned, and on platforms without usernames, such
as Klaviyo.

**verified** `boolean` *required*

Whether the external account is verified on the platform.

```json ExternalAccount theme={null}
{
	"id": "sacc_xxxxxxxxxxxx",
	"external_id": "17841400000000000",
	"name": "Pickaxe Pro",
	"parent_external_account": {
		"id": "sacc_yyyyyyyyyyyy",
		"platform": "facebook",
		"username": "pickaxepro",
		"name": "Pickaxe Pro",
		"profile_picture_url": "https://img.whop.com/sacc_yyyyyyyyyyyy.png",
		"verified": true,
		"external_id": "112233445566778"
	},
	"platform": "instagram",
	"profile_picture_url": "https://img.whop.com/sacc_xxxxxxxxxxxx.png",
	"scopes": ["advertise"],
	"partnership_status": null,
	"error": null,
	"url": "https://instagram.com/pickaxepro",
	"username": "pickaxepro",
	"verified": true
}
```


## Related topics

- [CLI Commands](https://docs.whop.com/cli/commands.md)
- [Create an External Account](https://docs.whop.com/api-reference/external-accounts/create-an-external-account.md)
- [List External Accounts](https://docs.whop.com/api-reference/external-accounts/list-external-accounts.md)