Contracts

Retrieve a contract

Returns the specified contract.

get/customers/{customerID}/contracts/{contractID}

Request

  • Base URL
    https://api.doit.com
  • URL
    https://api.doit.com/customers/{customerID}/contracts/{contractID}
  • Auth
    • API key in header Authorization
    • or API key in header X-Tenant-Id and API key in header Authorization

Path parameters

customerIDstring required
contractIDstring required

Response

OK - Contract returned.

idstring

The unique identifier of the contract.

customerIdstring

The customer (tenant) that holds the contract.

typestring

The immutable contract type.

status'draft' | 'scheduled' | 'active' | 'cancelled' | 'expired' | 'superseded'

The contract status.

namestring

The contract name.

startDatestring date-time nullable

The contract start date.

endDatestring date-time nullable

The contract end date.

renewalPolicy'auto' | 'manual' | 'fixed'

The renewal policy.

currentVersionNumberinteger nullable

The current version number of the contract.

timeCreatedstring date-time

When the contract was created.

Changes

No recorded changes to this operation across all 1 revision of this API.