# External Accounts API API

> External Accounts API API on Apizie: 9 endpoints (Retrieve all accounts you own, Create a Messenger account, Retrieve a Messenger account, Update a Messenger account, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/open-data:nexmo-external-accounts/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:nexmo-external-accounts`
- Category: Open Data
- Status: byok
- Source: https://developer.nexmo.com/
- Page: https://apizie.tech/api/open-data/nexmo-external-accounts
- OpenAPI: https://apizie.tech/api/open-data/nexmo-external-accounts/openapi.json

The External Accounts API is used to manage accounts for Viber Business Messages, Facebook Messenger and Whatsapp for use in the [Messages](https://developer.nexmo.com/messages/overview) and…

## Endpoints

### Retrieve all accounts you own
`GET https://apizie.tech/v1/open-data:nexmo-external-accounts/get-all-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| provider | string | no | Filter by provider |
| page_number | integer | no | Page number of the results |
| page_size | integer | no | Page size of the results |

### Create a Messenger account
`POST https://apizie.tech/v1/open-data:nexmo-external-accounts/create-messenger-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a Messenger account
`GET https://apizie.tech/v1/open-data:nexmo-external-accounts/get-messenger-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_id | string | yes | External id of the account you want to retrieve. In this case it is the Facebook Page ID. |

### Update a Messenger account
`POST https://apizie.tech/v1/open-data:nexmo-external-accounts/update-messenger-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_id | string | yes | External id of the account you want to update. In this case it is the Facebook Page ID. |
| body | object | yes | JSON request body |

### Delete a Messenger account
`POST https://apizie.tech/v1/open-data:nexmo-external-accounts/delete-messenger-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_id | string | yes | External id of the account you want to delete. In this case it is the Facebook Page ID. |

### Retrieve a Viber Service Message account
`GET https://apizie.tech/v1/open-data:nexmo-external-accounts/get-vsmaccount` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_id | string | yes | External id of the account you want to retrieve. In this case it will be your Viber Service Message ID. |

### Retrieve a Whatsapp account
`GET https://apizie.tech/v1/open-data:nexmo-external-accounts/get-waaccount` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_id | string | yes | External id of the account you want to retrieve. In this case it will be the WhatsApp number. |

### Link application to an account
`POST https://apizie.tech/v1/open-data:nexmo-external-accounts/link-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| provider | string | yes | Provider of the account you want to assign an application to |
| external_id | string | yes | External id of the account you want to assign an application to. This is channel dependent. For Facebook it will be your Facebook Page ID,… |
| body | object | yes | JSON request body |

### Unlink application from an account
`POST https://apizie.tech/v1/open-data:nexmo-external-accounts/unli-without-applicationnk-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| provider | string | yes | Provider of the account you want to unlink an application from |
| external_id | string | yes | External id of the account you want to unlink an application from |
| application_id | string | yes | Id of the application you want to unlink |

## Example
```
curl "https://apizie.tech/v1/open-data:nexmo-external-accounts/get-all-accounts" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the External Accounts API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/open-data:nexmo-external-accounts/get-all-accounts with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the External Accounts API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. External Accounts API itself also needs your own key from nexmo.com.

### Can AI agents use the External Accounts API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:nexmo-external-accounts.

### What is the status of the External Accounts API API?
Needs your own provider key (bring your own key)