Get a customer

One customer with its partner, account owner and service counts.

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

GET/customers/{customerId}

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 checkedread:customers

Path Parameters

customerIdstringuuidrequired

Response

application/json

Success

idstringuuidrequired

namestringrequired

domainstring | nullrequired

industrystring | nullrequired

lifecycleStatusstringrequired

onboardingStatusstringrequired

accountOwnerNamestring | nullrequired

partneranyrequired

isPartnerbooleanrequired

serviceCountsobjectrequired

3 child attributes

activeintegerrequired

minimum -9007199254740991maximum 9007199254740991

totalintegerrequired

minimum -9007199254740991maximum 9007199254740991

errorintegerrequired

minimum -9007199254740991maximum 9007199254740991

createdAtanyrequired

updatedAtanyrequired

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/customers/{customerId}' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN"

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

{
  "id": "<uuid>",
  "name": "<string>",
  "domain": "<string>",
  "industry": "<string>",
  "lifecycleStatus": "<string>",
  "onboardingStatus": "<string>",
  "accountOwnerName": "<string>",
  "partner": "<any>",
  "isPartner": true,
  "serviceCounts": {
    "active": 123,
    "total": 123,
    "error": 123
  },
  "createdAt": "<any>",
  "updatedAt": "<any>"
}

Was this page helpful?