# Numbers API API

> Numbers API API on Apizie: 5 endpoints (List the numbers you own, Buy a number, Cancel a number, Search available numbers, …) 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://zieapi.vercel.app/v1/open-data:nexmo-numbers/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:nexmo-numbers`
- Category: Open Data
- Status: byok
- Source: https://developer.nexmo.com
- Page: https://zieapi.vercel.app/api/open-data/nexmo-numbers
- OpenAPI: https://zieapi.vercel.app/api/open-data/nexmo-numbers/openapi.json

The Numbers API enables you to manage your existing numbers and buy new virtual numbers for use with the Vonage APIs. Further information is here:

## Endpoints

### List the numbers you own
`GET https://zieapi.vercel.app/v1/open-data:nexmo-numbers/get-owned-numbers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| application_id | string | no | The Application that you want to return the numbers for. |
| has_application | boolean | no | Set this optional field to `true` to restrict your results to numbers associated with an Application (any Application). Set to `false` to… |
| country | string | no | The two character country code in ISO 3166-1 alpha-2 format |
| pattern | string | no | The number pattern you want to search for. Use in conjunction with `search_pattern`. |
| search_pattern | integer | no | The strategy you want to use for matching: * `0` - Search for numbers that start with `pattern` (Note: all numbers are in E.164 format, so… |
| size | integer | no | Page size |
| index | integer | no | Page index |

### Buy a number
`POST https://zieapi.vercel.app/v1/open-data:nexmo-numbers/buy-anumber` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | Form fields as a JSON object |

### Cancel a number
`POST https://zieapi.vercel.app/v1/open-data:nexmo-numbers/cancel-anumber` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | Form fields as a JSON object |

### Search available numbers
`GET https://zieapi.vercel.app/v1/open-data:nexmo-numbers/get-available-numbers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| country | string | yes | The two character country code to filter on (in ISO 3166-1 alpha-2 format) |
| type | string | no | Set this parameter to filter the type of number, such as mobile or landline |
| pattern | string | no | The number pattern you want to search for. Use in conjunction with `search_pattern`. |
| search_pattern | integer | no | The strategy you want to use for matching: * `0` - Search for numbers that start with `pattern` (Note: all numbers are in E.164 format, so… |
| features | string | no | Available features are `SMS`, `VOICE` and `MMS`. To look for numbers that support multiple features, use a comma-separated value:… |
| size | integer | no | Page size |
| index | integer | no | Page index |

### Update a number
`POST https://zieapi.vercel.app/v1/open-data:nexmo-numbers/update-anumber` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | Form fields as a JSON object |

## Example
```
curl "https://zieapi.vercel.app/v1/open-data:nexmo-numbers/get-owned-numbers" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Numbers API API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/open-data:nexmo-numbers/get-owned-numbers with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

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

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