Vigilbase One APICustomers

List customer partner deals

Deal amounts and their aggregates are billing data (read:billing or admin:full). One exception: a partner sees the values of the deals it registered itself under read:partner_deals, per deal; other deals on its pipeline stay hidden. Internal staff who reach this route through read:customers, and a partner looking at another partner it manages, get the pipeline without amounts.

GET/api/customers/{id}/partner-deals

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 checkedadmin:fullread:customersread:partner_deals

Path Parameters

idstringrequired

Query Parameters

pipelineIdstring

Response

Success

# Token from `vigilbase login`, or an API key (vb_one_…)
curl --request GET \
  --url 'https://one.vigilbase.com/api/customers/{id}/partner-deals' \
  --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?