Skip to main content
GET
Get contract

Authorizations

x-api-key
string
header
required

API key for authentication. Get your key at https://app.tomorro.com/settings/integrations?integration=api-key

Path Parameters

id
string
required

The unique identifier (UUID) of the contract

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Contract

id
string
required

Unique identifier for the contract.

Example:

"ctr_550e8400-e29b-41d4-a716-446655440000"

name
string
required

The name or title of the contract.

Example:

"Service Agreement - Acme Corp"

status
string
required

The current status of the contract.

  • draft: The contract is being created or edited.
  • negotiating: The contract is being reviewed with counterparties.
  • signing: The contract is in the signature process.
  • signed: All parties have signed the contract.
  • canceled: The contract has been canceled.
Example:

"draft"

counterparty
object | null
required

The counterparty associated with this contract.

Example:
contractType
object | null
required

The type of the contract, it is composed of many templates.

Example:
templateId
string | null
required

The template used to create this contract.

Example:

"550e8400-e29b-41d4-a716-446655440003"

initialContractId
string | null
required

When this contract is an amendment, the id of the initial (root) contract it amends. null for initial contracts and for amendments that have been unlinked.

Example:

"550e8400-e29b-41d4-a716-446655440006"

folderId
string | null
required

The folder the contract is filed in. null when the contract sits at the root of the contract list. Matches the folderId filter on GET /contracts.

Example:

"550e8400-e29b-41d4-a716-446655440005"

author
object
required

The member who created this contract.

Example:
fields
object[]
required

The fields associated with this contract.

Example:
signatories
object[]
required

The signatories associated with this contract.

Example:
integration
object | null
required

The third-party system this contract is linked to, when it was created via an integration (Salesforce, HubSpot, or any other system sent as other). The shape mirrors the integration payload accepted on POST /contracts, so you can use this to look up the originating record in your CRM. null when the contract has no external link or was created from the Tomorro web app.

Example:
createdAt
string<date-time>
required

Time at which the contract was created. Formatted as an ISO 8601 date-time string.

Example:

"2024-01-15T10:30:00.000Z"

updatedAt
string<date-time>
required

Time at which the contract was last updated. Formatted as an ISO 8601 date-time string.

Example:

"2024-02-20T14:45:00.000Z"

contractUrl
string
required

Direct link to the contract in the Tomorro app (https://app.tomorro.com/{organizationSlug}/project/{contractId}).

Example:

"https://app.tomorro.com/acme-corporation/project/550e8400-e29b-41d4-a716-446655440000"

contractMembers
object[]

The list of participants with this contract.

Example: