ONoneflow
Contract

Get a contract by ID

Changed on

Use this endpoint to retrieve a specific contract by its ID.

get/contracts/{contract_id}

Request

  • Base URL
    https://api.oneflow.com/v1
  • Auth
    none declared. Required headers: x-oneflow-api-token

Path parameters

contract_idinteger required

The unique ID of the contract.

Headers

x-oneflow-api-tokenstring required

The API key of your Oneflow account.

x-oneflow-user-emailstring email
Example:john.doe@oneflow.com

The email address of a registered Oneflow user.

Response

Returns the requested contract.

idinteger required
importedboolean nullable

A flag denoting whether the contract has been imported or not.

marked_as_signedboolean nullable

A flag denoting whether the contract has been marked as signed or not.

published_timestring datetime nullable required
sign_laterboolean

A flag to indicate if the contract signing is postponed.

signing_period_expiry_timestring datetime nullable required
state'draft' | 'pending' | 'overdue' | 'signed' | 'declined' | 'unknown' required

One of the contract states.

state_updated_timestring datetime required
updated_timestring datetime nullable required

Changes

  • 0a4e1e88ac45Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the required property /// to the response with the status