Get a customer

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

GET/api/customers/{id}

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.

Permissions checkedread:customers

Path Parameters

idstringrequired

Query Parameters

includestring

Response

Success

More about this endpoint in the guide.

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

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?