Vigilbase One APISupport

List support tickets

The customer’s support requests, open ones only unless includeClosed is true (at most the newest 100). 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. They answer with the same bodies, with a Deprecation header and a successor-version link to this URL.

GET/support-tickets

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

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

includeClosedstring

One of:truefalseDefault:"false"

Response

application/json

Success

itemsobject[]required

12 child attributes

idstringrequired

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

numberanyrequired

titlestringrequired

statestringrequired

Pylon state: new, waiting_on_you, waiting_on_customer, on_hold, closed, …

prioritystring | nullrequired

tagsstring[]required

requesteranyrequired

assigneeanyrequired

bodyTextstring | nullrequired

The request’s text, without markup or file links.

createdAtanyrequired

updatedAtanyrequired

closedAtanyrequired

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' \
  --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>",
      "number": "<any>",
      "title": "<string>",
      "state": "<string>",
      "priority": "<string>",
      "tags": [
        "<string>"
      ],
      "requester": "<any>",
      "assignee": "<any>",
      "bodyText": "<string>",
      "createdAt": "<any>",
      "updatedAt": "<any>",
      "closedAt": "<any>"
    }
  ],
  "nextCursor": "<string>"
}

Was this page helpful?