Customer endpoints

A customer is the record Vigilbase keeps for an organisation it serves. Your organisation has one; a partner organisation also manages the customers it brought to Vigilbase. These endpoints read those records. Sign-in, permissions, rate limits and error shapes are on Vigilbase One API.

These are v1 operations, on https://api.vigilbase.com/one/v1:

This one has no v1 operation yet, and is on https://one.vigilbase.com:

Watchdog, monitoring and incident reads for a customer are on Watchdog and monitoring, and Cloudflare reads on Cloudflare.

Which customers you can read

{customerId} is a customer UUID. You can read your own organisation's customer and, in a partner organisation, the customers it manages. Any other ID answers 403, including an ID that doesn't exist.

Reports are the exception: a partner gets no reports for a managed customer, only for its own record. A customer billed through a partner is refused the contract and billing operations; ask the partner.

Some CLI customers commands, such as investigations and projects, read data reserved for Vigilbase staff; customer sign-ins don't get it.

Lists on these pages are cursor pages: { "items": [ … ], "nextCursor": "…" }. Times are ISO 8601 strings.

List customers

GET/customers lists the customers you can read, newest first. For a customer organisation that is your own record; for a partner organisation, the customers it manages, which needs read:partner_customers. Each item has id, name, domain, industry, lifecycleStatus, onboardingStatus, accountOwnerName, partner (id, name, or null), services (each with tool and status), createdAt and updatedAt.

Customer details

GET/customers/{customerId} returns one customer: the list fields without services, plus isPartner and serviceCounts (active, total, error).

{
  "id": "…",
  "name": "Example Ltd",
  "domain": "example.com",
  "industry": null,
  "lifecycleStatus": "active",
  "onboardingStatus": "completed",
  "accountOwnerName": "…",
  "partner": null,
  "isPartner": false,
  "serviceCounts": { "active": 3, "total": 3, "error": 0 },
  "createdAt": "2026-03-02T10:00:00.000Z",
  "updatedAt": "2026-10-30T09:12:44.000Z"
}

The other reads of one customer:

GET/customers/{customerId}/organization returns hasOrganization and organizationId: whether the customer has its Vigilbase Identity organisation, the one its people sign in to.

GET/api/customers/{id} on one.vigilbase.com returns the full record in data, with partner, services, endpoints, integrationStatus and quotes. Service prices are left out unless you have read:billing.

Reports

GET/customers/{customerId}/reports lists the monthly security reports and quarterly business reviews together, latest period first. Each item has id, kind (monthly or quarterly), period (start, end, label), status, updatedAt and isShared. You see published quarterly reviews only.

GET/customers/{customerId}/recon-reports lists only the monthly security reports, the ones One shows under Reports, newest period first. Each item has id, period, status (pending, generating, completed or failed), generatedAt, hasPublicLink and availableSections.

GET/customers/{customerId}/recon-reports/{reportId} returns one report with its sections: executiveSummary, threatLandscape, insights, aiAnalysis, comparison, endpoint, backup, cloudflare, support and billing, plus period, status, branding and publicLink (whether a share link exists; the link itself isn't returned). billing is null unless you have read:billing, and always for a customer billed through a partner.

Contracts

GET/customers/{customerId}/contracts lists the contracts the customer owns or that its partner linked to it, newest first.

Each contract has id, reference (the contract number, such as C-1001), name, description, status, isLinked, effectiveDate, expirationDate, signedDate, autoRenewal, renewalNoticeDays, billingFrequency, totalValue, currency, lineItems, invoices, createdAt and updatedAt. Contract amounts are in major units (dollars, not cents), and null unless you have read:billing. A contract with isLinked: true belongs to the partner: you get its summary only, and its amounts, line items and invoices come back null or empty.

GET/customers/{customerId}/contracts/{contractId} returns one contract with the same fields plus attachments (each with id, fileName, fileSize, mimeType, attachmentType, description, version, isLatest, uploadedAt).

GET/customers/{customerId}/usage-alerts lists active line items whose usage is near or over the contracted limit, over-limit first. Each has contractId, contractName, serviceName, serviceType, usagePercentage and status (warning, critical or over_limit).

Billing overview

GET/customers/{customerId}/billing reads the customer's billing live from Stripe:

A 502 problem with upstream_unavailable means Stripe couldn't be reached.

Invoices and subscriptions

These two read Stripe live. Amounts are in the currency's minor units (cents for USD).

GET/customers/{customerId}/invoices lists the customer's most recent invoices, up to 100, newest first. Filter with status: draft, open, paid, uncollectible or void. Each invoice has id, number, status, amountDue, amountPaid, amountRemaining, currency, description, subscriptionId, lineCount, createdAt, dueDate, paidAt, hostedInvoiceUrl and invoicePdfUrl.

GET/customers/{customerId}/subscriptions lists the customer's subscriptions. Each has id, status, description (the product names), currentPeriodStart, currentPeriodEnd, cancelAtPeriodEnd, canceledAt, createdAt and items: each item's id, quantity, price (unitAmount, currency, interval and more) and product (id, name, description).

Older paths

Each v1 operation here also answers at an older path on https://one.vigilbase.com/api, such as GET/api/customers/{id}/summary for GET/customers/{customerId}. The older paths are deprecated aliases and will be retired with 410 Gone. Each operation's page in the API reference names its older path. See hosts.