Skip to navigation

List agent closures

Returns the closures of whole days that are in progress or coming, by date, at most 50. Closures that are over are not listed and are deleted automatically. The date of a closure is a day of the agent timezone. Required scope: agents:operate. With a test key (vx_test_) it behaves exactly as with a live key and consumes nothing.

Authentication

AuthorizationBearer
API key created by an Owner or Admin of the organization. Never in the query string.

Path parameters

agent_idstringRequiredformat: "^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$"

Id of an agent of the organization, as returned by GET /agents.

Headers

VoxAI-VersionenumOptional

API version for this request; defaults to the version the key is pinned to.

Allowed values:

Response

Successful response.
object"list"

Always list.

agent_idstring
Id of the agent the closures belong to.
datalist of objects

Current and upcoming closures (at most 50), by date. Past closures are not listed and are deleted automatically.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error