---
title: "Get contract by ID"
method: GET
path: "/v3/contracts/{id}"
tags: ["Contracts"]
---

# Get contract by ID

`GET /v3/contracts/{id}`

## Path parameters

- `id` string, required

## Response `200`

The contract

- object
  - `payload` object, required — Response payload, will be empty when success is false
    - `id` string, required — Unique identifier for the contract
    - `fileName` string, required — Name of the contract file
    - `name` string, required — Display name of the contract
    - `status` string, required — Current status of the contract
    - `customerId` string, required — Identifier of the customer associated with this contract
    - `customerName` string — Name of the customer associated with this contract
    - `createdAt` string, date-time — Timestamp when the contract was created
    - `closeDate` string — Close date of the contract
    - `lastUpdatedAt` string — Timestamp when the contract was last updated
    - `deletedAt` string, date-time — Timestamp when the contract was deleted. Null for live contracts; populated on the deleted-contracts endpoint.
    - `externalIds` ExternalIdDto[] — External IDs and external source types of the contract
      - `externalId` string — The external identifier
      - `sourceType` 'QUICKBOOKS' | 'NETSUITE' | 'RILLET' | 'SAGE_INTACCT' | 'SALESFORCE' | 'HUBSPOT' | 'AVALARA' | 'ANROK' | 'STRIPE'
      - `metadata` object — Additional metadata for the external identifier
    - `source` 'CRM' | 'EMAIL' | 'UPLOAD' | 'API' | 'ERP' | 'INTERNAL' — The source of the contract
    - `jobId` string — The workflow job ID for the contract processing
  - `success` boolean, required — Boolean with true=success, false=failure
  - `message` string, required — Plain-text description of the result
  - `error` IntegratorsApiError, required
    - `code` number, required — API response code
    - `message` string, required — API response message
    - `details` object — Additional details about the error

## Other responses

- `400` — Contract is deleted
- `404` — Contract not found

---

[API](https://skmtc.net/tabsplatform/apis/tabs-external-api.md) · [All operations](https://skmtc.net/tabsplatform/apis/tabs-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tabsplatform/tabs-external-api/versions/7e8885517814/schema)