Vigilbase One APISupport

List a support ticket’s messages

The conversation on one support request, oldest first (the newest 200 messages). Staff must name the customer with customerId; everyone else gets their own organisation’s customer.

Deprecated aliases: GET https://one.vigilbase.com/api/support/tickets/{issueId}/messages. They answer with the same bodies, with a Deprecation header and a successor-version link to this URL.

GET/support-tickets/{ticketId}/messages

Authorizations

Send one of these:

AuthorizationstringAccess tokenheaderrequired

Bearer access token from Vigilbase Identity (auth.vigilbase.com), sent as Authorization: Bearer <token>. The CLI gets one with vigilbase login. Scope: one:api.

AuthorizationstringAPI keyheaderrequired

Organisation API key (vb_one_…) from Settings → API keys in Vigilbase One, sent as Authorization: Bearer vb_one_…. Read-only keys work. See organisation API keys.

AuthorizationstringMCP tokenheaderrequired

Vigilbase Identity access token issued to an MCP client (mcp.vigilbase.com). Scope: one:read.

Permissions checkedsupport:access

Path Parameters

ticketIdstringrequired

pattern ^[A-Za-z0-9-]{1,64}$

Query Parameters

A cursor-paginated list: the response holds items, and while it has a nextCursor, pass it as cursor for the next page. See pagination.

cursorstring

The nextCursor of the previous page. Leave it out for the first page.

max length 512

limitinteger

How many items to return per page.

Default:50maximum 200

customerIdstringuuid

Response

application/json

Success

itemsobject[]required

8 child attributes

idstringrequired

authorNamestringrequired

fromVigilbasebooleanrequired

isInternalNotebooleanrequired

Always false for customers; staff also see internal notes.

sourcestring | nullrequired

textstringrequired

attachmentsobject[]required

3 child attributes

indexintegerrequired

Position of the file on its message.

minimum 0maximum 9007199254740991

namestringrequired

kindstringrequired

One of:imagepdffile

createdAtanyrequired

nextCursorstring

2 response headers

X-Request-Idstring

The request ID: yours when it was well-formed, otherwise a new one. Quote it to support.

API-Versionstring

The major API version (informational; the version is in the path).

More about this endpoint in the guide.

# Token from `vigilbase login`, or an API key (vb_one_…)
curl --request GET \
  --url 'https://api.vigilbase.com/one/v1/support-tickets/{ticketId}/messages' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN"

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

{
  "items": [
    {
      "id": "<string>",
      "authorName": "<string>",
      "fromVigilbase": true,
      "isInternalNote": true,
      "source": "<string>",
      "text": "<string>",
      "attachments": [
        {
          "index": 123,
          "name": "<string>",
          "kind": "image"
        }
      ],
      "createdAt": "<any>"
    }
  ],
  "nextCursor": "<string>"
}

Was this page helpful?