Get customer overview

GET /api/customers/{id}/overview on the Vigilbase One API.

GET/api/customers/{id}/overview

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.

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.

Path Parameters

idstringrequired

Body

application/json

The catalog has no JSON Schema for this body. One validates it with the schema below.

Validation schema

QuerySchema = z.object({ parts: z.array(z.string().min(1).max(300)).min(1).max(OVERVIEW_MAX_PARTS) })

Response

Success

# Token from `vigilbase login`, or an API key (vb_one_…)
curl --request GET \
  --url 'https://one.vigilbase.com/api/customers/{id}/overview' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{}'

Set VIGILBASE_TOKEN to an Identity access token or an organisation API key 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?