Agents API
Last updated November 14, 2026 ·
6 views
· 1 min read
1 min read
Read the agents on your site.
Base URL: https://api-admin-us-east.velaro.com/api/v1. Send your API key as Authorization: Bearer vlk_.... Create keys under Settings > API Keys; each key carries only the scopes you grant it.
Current availability of the site's agents with a count per status, optionally limited to one team.
GET /api/v1/agents/availability
Required scope: read:agents
| Parameter | In | Type | Notes |
|---|---|---|---|
| teamId | query | integer (int32) | optional |
List agents
GET /api/v1/agents
Required scope: read:agents
| Parameter | In | Type | Notes |
|---|---|---|---|
| page | query | integer (int32) | optional, default 1 |
| pageSize | query | integer (int32) | optional, default 100 |
Response: JSON list of AgentDto
Common responses: 401 for a missing or invalid key, 403 when the key lacks the scope, 429 when the rate limit is reached.
Email
Was this article helpful?
Appointments API