Conversations API
Read the conversations 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.
Get conversation
GET /api/v1/conversations/{id}
Required scope: read:conversations
| Parameter | In | Type | Notes |
|---|---|---|---|
| id | path | integer (int64) | required |
Response: JSON ConversationDto
List conversations
GET /api/v1/conversations
Required scope: read:conversations
| Parameter | In | Type | Notes |
|---|---|---|---|
| status | query | string | optional |
| from | query | string (date-time) | optional |
| to | query | string (date-time) | optional |
| page | query | integer (int32) | optional, default 1 |
| pageSize | query | integer (int32) | optional, default 50 |
Common responses: 401 for a missing or invalid key, 403 when the key lacks the scope, 429 when the rate limit is reached.
Was this article helpful?