TOtoriihq
Contracts

Get contract

Returns a single contract.<br/><br/>Add lineItems to fields to include the contract's line items (products / SKUs on the order) in the response; they are not returned otherwise, and the list endpoint never returns them. Example: GET /contracts/123?fields=id,name,lineItems<br/><br/>

<p><ul><li>Rate limit: 800 requests per minute</li></ul></p>
get/contracts/{idContract}

Request

  • Base URL
    https://api.toriihq.com/v1.0
  • Auth
    API key in header Authorization

Path parameters

idContractinteger required

Unique contract identifier

Query parameters

fieldsstring

List of fields to return for each contract.<br>Allowed fields: id, idApp, name, owner, status, createdBy and all fields from /contracts/fields

Headers

x-api-version'1.0' | '1.1'

API version header (e.g., 1.0, 1.1)

Response

Get contract

Example response

{
  "contract": {
    "id": 1000,
    "name": "Salesforce contract",
    "status": "pipeline"
  }
}

Changes

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