Get a contract

One contract with its line items, invoices and attachments. Amounts are null without billing access.

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

GET/customers/{customerId}/contracts/{contractId}

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:contracts

Path Parameters

customerIdstringuuidrequired

contractIdstringuuidrequired

Response

application/json

Success

idstringuuidrequired

referencestring | nullrequired

The human contract number, e.g. C-1001.

namestringrequired

descriptionstring | nullrequired

statusstring | nullrequired

isLinkedbooleanrequired

Owned by the partner and linked to this customer: a summary only.

effectiveDatestring | nullrequired

expirationDatestring | nullrequired

signedDatestring | nullrequired

autoRenewalboolean | nullrequired

renewalNoticeDaysanyrequired

billingFrequencystring | nullrequired

totalValuenumber | nullrequired

Amount in major units; null when hidden from the caller (no billing access) or not set.

currencystring | nullrequired

notesstring | nullrequired

Vigilbase’s notes on the contract; null for callers outside Vigilbase.

agreementUrlstring | nullrequired

The signed agreement (Common Paper), an https link; null for callers outside Vigilbase.

lineItemsobject[]required

14 child attributes

idstringuuidrequired

namestring | nullrequired

descriptionstring | nullrequired

serviceIdanyrequired

quantitynumber | nullrequired

unitPricenumber | nullrequired

Amount in major units; null when hidden from the caller (no billing access) or not set.

totalPricenumber | nullrequired

Amount in major units; null when hidden from the caller (no billing access) or not set.

includedQuantitynumber | nullrequired

overageRatenumber | nullrequired

Amount in major units; null when hidden from the caller (no billing access) or not set.

quantityLimitnumber | nullrequired

quantityUnitstring | nullrequired

bandwidthLimitTbnumber | nullrequired

requestsLimitMillionsnumber | nullrequired

isActivebooleanrequired

invoicesobject[]required

10 child attributes

idstringuuidrequired

stripeInvoiceIdstring | nullrequired

invoiceNumberstring | nullrequired

amountDuenumber | nullrequired

Amount in major units; null when hidden from the caller (no billing access) or not set.

amountPaidnumber | nullrequired

Amount in major units; null when hidden from the caller (no billing access) or not set.

currencystring | nullrequired

statusstring | nullrequired

invoiceDatestring | nullrequired

dueDatestring | nullrequired

paidAtanyrequired

createdAtanyrequired

updatedAtanyrequired

attachmentsobject[]required

9 child attributes

idstringuuidrequired

fileNamestringrequired

fileSizeanyrequired

mimeTypestring | nullrequired

attachmentTypestring | nullrequired

descriptionstring | nullrequired

versionanyrequired

isLatestbooleanrequired

uploadedAtanyrequired

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}/contracts/{contractId}' \
  --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>",
  "reference": "<string>",
  "name": "<string>",
  "description": "<string>",
  "status": "<string>",
  "isLinked": true,
  "effectiveDate": "<string>",
  "expirationDate": "<string>",
  "signedDate": "<string>",
  "autoRenewal": true,
  "renewalNoticeDays": "<any>",
  "billingFrequency": "<string>",
  "totalValue": 123,
  "currency": "<string>",
  "notes": "<string>",
  "agreementUrl": "<string>",
  "lineItems": [
    {
      "id": "<uuid>",
      "name": "<string>",
      "description": "<string>",
      "serviceId": "<any>",
      "quantity": 123,
      "unitPrice": 123,
      "totalPrice": 123,
      "includedQuantity": 123,
      "overageRate": 123,
      "quantityLimit": 123,
      "quantityUnit": "<string>",
      "bandwidthLimitTb": 123,
      "requestsLimitMillions": 123,
      "isActive": true
    }
  ],
  "invoices": [
    {
      "id": "<uuid>",
      "stripeInvoiceId": "<string>",
      "invoiceNumber": "<string>",
      "amountDue": 123,
      "amountPaid": 123,
      "currency": "<string>",
      "status": "<string>",
      "invoiceDate": "<string>",
      "dueDate": "<string>",
      "paidAt": "<any>"
    }
  ],
  "createdAt": "<any>",
  "updatedAt": "<any>",
  "attachments": [
    {
      "id": "<uuid>",
      "fileName": "<string>",
      "fileSize": "<any>",
      "mimeType": "<string>",
      "attachmentType": "<string>",
      "description": "<string>",
      "version": "<any>",
      "isLatest": true,
      "uploadedAt": "<any>"
    }
  ]
}

Was this page helpful?