How can we help you?

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

ParameterInTypeNotes
idpathinteger (int64)required

Response: JSON ConversationDto

List conversations

GET /api/v1/conversations

Required scope: read:conversations

ParameterInTypeNotes
statusquerystringoptional
fromquerystring (date-time)optional
toquerystring (date-time)optional
pagequeryinteger (int32)optional, default 1
pageSizequeryinteger (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.

Share: Email

Was this article helpful?