Workspace

Search

GEThttps://voxa.abhinavyadav.in/api/v1/search

Finds agents, calls and members by name, number or id, limited to what your role can see.

Authorization

An API key (X-API-Key or Authorization: Bearer), or a session token.

X-API-KeyAuthorization: Bearer

Query parameters

qstringrequired

At least 2 characters.

2 to 80 characters

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.

See the 200 example next to the code samples.

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

429Over the per-key rate limit; wait for Retry-After.

detailstring

What went wrong, in plain words.

curl --request GET \
  --url 'https://voxa.abhinavyadav.in/api/v1/search?timezone=Asia/Kolkata' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://voxa.abhinavyadav.in/api/v1/search"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "X-API-Key": "<api-key>",
}

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

const response = await fetch("https://voxa.abhinavyadav.in/api/v1/search?timezone=Asia/Kolkata", {
  headers: {
    "X-API-Key": "<api-key>",
  },
})
const data = await response.json()
console.log(response.status, data)

Response

{
  "results": [
    {
      "type": "agent",
      "id": "9b1c…",
      "title": "Front desk",
      "subtitle": "Agent",
      "url": "/agents/9b1c…"
    }
  ]
}

{
  "detail": "sign in required"
}

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

{
  "detail": "rate limit exceeded; slow down"
}