Phone numbers

Search Numbers

GEThttps://api.vaakyo.com/api/v1/numbers/search

Numbers you can rent, with their monthly and setup price in the workspace’s currency (paise or cents; INR at today’s rate).

Authorization

A signed-in member with the numbers.manage permission (Authorization: Bearer session token). API keys can’t do this.

Authorization: Bearernumbers.manage

Query parameters

country_isostringdefault: "IN"

2 to 2 characters

typeenum<string>

One of:fixedmobiletollfreelocal

patternstring

at most 20 characters · matches ^[0-9]*$

regionstring

at most 60 characters

offsetintegerdefault: 0

0 to 1000

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Response

200Success.

No body.

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

curl --request GET \
  --url 'https://api.vaakyo.com/api/v1/numbers/search?timezone=Asia/Kolkata' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.vaakyo.com/api/v1/numbers/search"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "Authorization": "Bearer <token>",
}

response = requests.get(url, params=params, headers=headers)
print(response.status_code, response.json())

const response = await fetch("https://api.vaakyo.com/api/v1/numbers/search?timezone=Asia/Kolkata", {
  headers: {
    "Authorization": "Bearer <token>",
  },
})
const data = await response.json()
console.log(response.status, data)

Response

{
  "detail": "sign in required"
}

{
  "detail": "your role cannot do this (numbers.manage)"
}

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "body",
        "name"
      ],
      "msg": "Field required",
      "input": {}
    }
  ]
}