# Get a contract

> One contract with its line items, invoices and attachments.

Source: https://docs.vigilbase.com/one/api/reference/contracts/contracts-get

`GET https://api.vigilbase.com/one/v1/customers/{customerId}/contracts/{contractId}`

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.

## Authorizations

Send one of these:

- `Authorization` (string, header, required): Bearer access token from Vigilbase Identity (`auth.vigilbase.com`), sent as `Authorization: Bearer <token>`. The CLI gets one with `vigilbase login`. Scope: `one:api`.
- `Authorization` (string, header, required): 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](https://docs.vigilbase.com/one/api#organisation-api-keys).
- `Authorization` (string, header, required): Vigilbase Identity access token issued to an MCP client (mcp.vigilbase.com). Scope: `one:read`.
- Permissions checked: `read:contracts`

## Path parameters

- `customerId` (string, required)
- `contractId` (string, required)

## Responses

Errors are problem details (`application/problem+json`). See [errors](https://docs.vigilbase.com/one/api#errors).

### 200 (application/json)

Success

- `id` (string, required)
- `reference` (string | null, required): The human contract number, e.g. C-1001.
- `name` (string, required)
- `description` (string | null, required)
- `status` (string | null, required)
- `isLinked` (boolean, required): Owned by the partner and linked to this customer: a summary only.
- `effectiveDate` (string | null, required)
- `expirationDate` (string | null, required)
- `signedDate` (string | null, required)
- `autoRenewal` (boolean | null, required)
- `renewalNoticeDays` (any, required)
- `billingFrequency` (string | null, required)
- `totalValue` (number | null, required): Amount in major units; null when hidden from the caller (no billing access) or not set.
- `currency` (string | null, required)
- `notes` (string | null, required): Vigilbase’s notes on the contract; null for callers outside Vigilbase.
- `agreementUrl` (string | null, required): The signed agreement (Common Paper), an https link; null for callers outside Vigilbase.
- `lineItems` (object[], required)
  - `id` (string, required)
  - `name` (string | null, required)
  - `description` (string | null, required)
  - `serviceId` (any, required)
  - `quantity` (number | null, required)
  - `unitPrice` (number | null, required): Amount in major units; null when hidden from the caller (no billing access) or not set.
  - `totalPrice` (number | null, required): Amount in major units; null when hidden from the caller (no billing access) or not set.
  - `includedQuantity` (number | null, required)
  - `overageRate` (number | null, required): Amount in major units; null when hidden from the caller (no billing access) or not set.
  - `quantityLimit` (number | null, required)
  - `quantityUnit` (string | null, required)
  - `bandwidthLimitTb` (number | null, required)
  - `requestsLimitMillions` (number | null, required)
  - `isActive` (boolean, required)
- `invoices` (object[], required)
  - `id` (string, required)
  - `stripeInvoiceId` (string | null, required)
  - `invoiceNumber` (string | null, required)
  - `amountDue` (number | null, required): Amount in major units; null when hidden from the caller (no billing access) or not set.
  - `amountPaid` (number | null, required): Amount in major units; null when hidden from the caller (no billing access) or not set.
  - `currency` (string | null, required)
  - `status` (string | null, required)
  - `invoiceDate` (string | null, required)
  - `dueDate` (string | null, required)
  - `paidAt` (any, required)
- `createdAt` (any, required)
- `updatedAt` (any, required)
- `attachments` (object[], required)
  - `id` (string, required)
  - `fileName` (string, required)
  - `fileSize` (any, required)
  - `mimeType` (string | null, required)
  - `attachmentType` (string | null, required)
  - `description` (string | null, required)
  - `version` (any, required)
  - `isLatest` (boolean, required)
  - `uploadedAt` (any, required)

### 400 (application/problem+json)

Problem: `validation_failed`.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required): Minimum 400, maximum 599.
- `detail` (string, required)
- `instance` (string)
- `code` (string, required): One of `bad_request`, `validation_failed`, `idempotency_key_invalid`, `unauthorized`, `invalid_api_key`, `api_key_revoked`, `api_key_expired`, `forbidden`, `step_up_required`, `staff_only`, `read_only_key`, `not_for_api_keys`, `insufficient_scope`, `not_found`, `method_not_allowed`, `conflict`, `idempotency_in_progress`, `gone`, `length_required`, `precondition_failed`, `payload_too_large`, `unsupported_media_type`, `unprocessable_entity`, `idempotency_key_reused`, `rate_limit_exceeded`, `internal_error`, `upstream_unavailable`, `service_unavailable`.
- `requestId` (string, required)
- `docs` (string)
- `errors` (object[])
  - `pointer` (string, required)
  - `message` (string, required)
- `retryAfterSeconds` (integer): Minimum 0, maximum 9007199254740991.

### 401 (application/problem+json)

Problem: `unauthorized`.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required): Minimum 400, maximum 599.
- `detail` (string, required)
- `instance` (string)
- `code` (string, required): One of `bad_request`, `validation_failed`, `idempotency_key_invalid`, `unauthorized`, `invalid_api_key`, `api_key_revoked`, `api_key_expired`, `forbidden`, `step_up_required`, `staff_only`, `read_only_key`, `not_for_api_keys`, `insufficient_scope`, `not_found`, `method_not_allowed`, `conflict`, `idempotency_in_progress`, `gone`, `length_required`, `precondition_failed`, `payload_too_large`, `unsupported_media_type`, `unprocessable_entity`, `idempotency_key_reused`, `rate_limit_exceeded`, `internal_error`, `upstream_unavailable`, `service_unavailable`.
- `requestId` (string, required)
- `docs` (string)
- `errors` (object[])
  - `pointer` (string, required)
  - `message` (string, required)
- `retryAfterSeconds` (integer): Minimum 0, maximum 9007199254740991.

### 403 (application/problem+json)

Problem: `forbidden`.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required): Minimum 400, maximum 599.
- `detail` (string, required)
- `instance` (string)
- `code` (string, required): One of `bad_request`, `validation_failed`, `idempotency_key_invalid`, `unauthorized`, `invalid_api_key`, `api_key_revoked`, `api_key_expired`, `forbidden`, `step_up_required`, `staff_only`, `read_only_key`, `not_for_api_keys`, `insufficient_scope`, `not_found`, `method_not_allowed`, `conflict`, `idempotency_in_progress`, `gone`, `length_required`, `precondition_failed`, `payload_too_large`, `unsupported_media_type`, `unprocessable_entity`, `idempotency_key_reused`, `rate_limit_exceeded`, `internal_error`, `upstream_unavailable`, `service_unavailable`.
- `requestId` (string, required)
- `docs` (string)
- `errors` (object[])
  - `pointer` (string, required)
  - `message` (string, required)
- `retryAfterSeconds` (integer): Minimum 0, maximum 9007199254740991.

### 404 (application/problem+json)

Problem: `not_found`.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required): Minimum 400, maximum 599.
- `detail` (string, required)
- `instance` (string)
- `code` (string, required): One of `bad_request`, `validation_failed`, `idempotency_key_invalid`, `unauthorized`, `invalid_api_key`, `api_key_revoked`, `api_key_expired`, `forbidden`, `step_up_required`, `staff_only`, `read_only_key`, `not_for_api_keys`, `insufficient_scope`, `not_found`, `method_not_allowed`, `conflict`, `idempotency_in_progress`, `gone`, `length_required`, `precondition_failed`, `payload_too_large`, `unsupported_media_type`, `unprocessable_entity`, `idempotency_key_reused`, `rate_limit_exceeded`, `internal_error`, `upstream_unavailable`, `service_unavailable`.
- `requestId` (string, required)
- `docs` (string)
- `errors` (object[])
  - `pointer` (string, required)
  - `message` (string, required)
- `retryAfterSeconds` (integer): Minimum 0, maximum 9007199254740991.

### 429 (application/problem+json)

Problem: `rate_limit_exceeded`.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required): Minimum 400, maximum 599.
- `detail` (string, required)
- `instance` (string)
- `code` (string, required): One of `bad_request`, `validation_failed`, `idempotency_key_invalid`, `unauthorized`, `invalid_api_key`, `api_key_revoked`, `api_key_expired`, `forbidden`, `step_up_required`, `staff_only`, `read_only_key`, `not_for_api_keys`, `insufficient_scope`, `not_found`, `method_not_allowed`, `conflict`, `idempotency_in_progress`, `gone`, `length_required`, `precondition_failed`, `payload_too_large`, `unsupported_media_type`, `unprocessable_entity`, `idempotency_key_reused`, `rate_limit_exceeded`, `internal_error`, `upstream_unavailable`, `service_unavailable`.
- `requestId` (string, required)
- `docs` (string)
- `errors` (object[])
  - `pointer` (string, required)
  - `message` (string, required)
- `retryAfterSeconds` (integer): Minimum 0, maximum 9007199254740991.

### 503 (application/problem+json)

Problem: `service_unavailable`.

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required): Minimum 400, maximum 599.
- `detail` (string, required)
- `instance` (string)
- `code` (string, required): One of `bad_request`, `validation_failed`, `idempotency_key_invalid`, `unauthorized`, `invalid_api_key`, `api_key_revoked`, `api_key_expired`, `forbidden`, `step_up_required`, `staff_only`, `read_only_key`, `not_for_api_keys`, `insufficient_scope`, `not_found`, `method_not_allowed`, `conflict`, `idempotency_in_progress`, `gone`, `length_required`, `precondition_failed`, `payload_too_large`, `unsupported_media_type`, `unprocessable_entity`, `idempotency_key_reused`, `rate_limit_exceeded`, `internal_error`, `upstream_unavailable`, `service_unavailable`.
- `requestId` (string, required)
- `docs` (string)
- `errors` (object[])
  - `pointer` (string, required)
  - `message` (string, required)
- `retryAfterSeconds` (integer): Minimum 0, maximum 9007199254740991.

### default (application/problem+json)

Problem details (RFC 9457).

- `type` (string, required)
- `title` (string, required)
- `status` (integer, required): Minimum 400, maximum 599.
- `detail` (string, required)
- `instance` (string)
- `code` (string, required): One of `bad_request`, `validation_failed`, `idempotency_key_invalid`, `unauthorized`, `invalid_api_key`, `api_key_revoked`, `api_key_expired`, `forbidden`, `step_up_required`, `staff_only`, `read_only_key`, `not_for_api_keys`, `insufficient_scope`, `not_found`, `method_not_allowed`, `conflict`, `idempotency_in_progress`, `gone`, `length_required`, `precondition_failed`, `payload_too_large`, `unsupported_media_type`, `unprocessable_entity`, `idempotency_key_reused`, `rate_limit_exceeded`, `internal_error`, `upstream_unavailable`, `service_unavailable`.
- `requestId` (string, required)
- `docs` (string)
- `errors` (object[])
  - `pointer` (string, required)
  - `message` (string, required)
- `retryAfterSeconds` (integer): Minimum 0, maximum 9007199254740991.

## Example request

```bash
# 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"
```

## Example response (200)

```json
{
  "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>"
    }
  ]
}
```

See also the [guide](https://docs.vigilbase.com/one/api/customers).