Vigilbase One APIVigil

List your Vigil conversations

Every Vigil conversation the signed-in operator started, company chats and chats about customers together (GET /api/vigil/conversations/mine). Used by the iOS chat list so conversations begun on a customer page on the web are listed too. Vigilbase operators only: authorized as a company-scope request, so customers (who have one scope already) get 404.

GET/api/vigil/conversations/mine

Authorizations

AuthorizationstringAccess tokenheaderrequired

Bearer access token from Vigilbase Identity (auth.vigilbase.com), sent as Authorization: Bearer <token>. The CLI gets one with vigilbase login. Organisation API keys can't call this endpoint: it acts for a signed-in person or changes how people sign in.

Query Parameters

limitinteger

Default:20minimum 1maximum 50

offsetinteger

Default:0minimum 0maximum 10000

qstring

max length 200

Response

Success

# Token from `vigilbase login`. API keys can't call this.
curl --request GET \
  --url 'https://one.vigilbase.com/api/vigil/conversations/mine' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN"

Set VIGILBASE_TOKEN to an Identity access token first, or use Try it.

Responses

200Success

401Authentication required

403Not permitted

The catalog doesn't include example response bodies for this endpoint.

Was this page helpful?