Search the provider catalogue for numbers to buy
What could be bought in one country, priced the way the dashboard prices it — the platform markup is already applied, so the figures here are what the company would actually be charged. Read-only: this API cannot buy a number. Buying spends the company's credit balance, is not refundable, and is deliberately left to a human in the dashboard; the point of this endpoint is to be able to tell that human what to buy. Country is required because the catalogue lives at the provider and an unscoped lookup costs a request without answering anything. Two things about the answer that are easy to get wrong: entries are number classes, not individual numbers — the provider sells by area code and kind, and number is a mask ending in XXXX, with the actual digits assigned at purchase; and the current provider ignores city_id and type, returning the whole country either way, so treat those two as hints for the future and filter what you show yourself.
Request
- Base URL: https://wardenpoint.com (the document declares no server; this is the origin it was published from)
- URL: https://wardenpoint.com/api/v1/phone-numbers/available
- Auth: API key in header X-API-Key
Query parameters
ISO 3166-1 alpha-2, exactly two letters.
Provider-specific city identifier. Accepted and validated, but the current provider ignores it — the whole country comes back regardless.
Accepted and validated, but the current provider ignores it — every kind comes back regardless. Filter the returned type field yourself. Note that the answer may also carry national, which this parameter does not accept.
Response
Number classes on offer.
Example response
{
"data": [
{
"number": "+4822XXXX"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.