v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Contracts

Get Contract

Use this API to retrieve a single contract by its unique identifier. The response will include details such as the created date, approved date, and corresponding approvers.

get/api/vendor/v1/contracts/{contractId}/contracts

Path parameters

contractIdstring uuid required

Example:db3398d0-cbce-4796-b248-614661cf256b

The unique identifier of the contract.

Query parameters

excludeAttachmentsboolean

The flag to indicate if the attachments list shall be returned in the response.

Response

idstring uuid

The unique identifier of the returned contract.

namestring

The name of the returned contract.

vendorIdstring uuid

The vendor identifier of the returned contract.

vendorNamestring

The vendor name of the returned contract.

orgGroupIdstring uuid

The organization group of the returned contract.

status'NEW' | 'IN_PROGRESS' | 'ACTIVE' | 'EXPIRED' | 'TERMINATED'

The status of the returned contract.

agreementCreatedDatestring date-time

The creation date of the returned agreement.

contractTypeIdstring uuid

The contract type identifier of returned contract.

contractTypeNamestring

The contract type name of returned contract.

contractTypeNameKeystring

The contract type translation key.

approvedDatestring date

The approval date of the returned contract.

expirationDatestring date

The expiration date of the returned contract.

contractOwnerIdstring uuid

The owner identifier of the returned contract.

contractOwnerstring

The owner name of the returned contract.

vendorContactstring email

The vendor contact of the returned contract.

approversstring

The approvers list of the returned contract.

notestring

The notes of the returned contract.

costnumber

The cost of the returned contract.

urlstring uri

The document URL of the returned contract.

schemaIdstring uuid

The schema identifier of the returned contract.

attributeValuesobject

The custom attributes of the returned contract.

viewOnlyboolean

The read-only flag of the returned contract.

statusKeystring

The status translation key of the returned contract.

Example response

{
  "id": "db3398d0-cbce-4796-b248-614661cf256b",
  "name": "Microsoft Azure Services Agreement",
  "vendorId": "5ec48d61-1562-43ad-87a3-6fc7073494af",
  "vendorName": "Microsoft",
  "orgGroupId": "a41972ae-2050-4126-b314-1a58d08ea116",
  "attachments": [
    {
      "id": "db3398d0-cbce-4796-b248-614661cf256b",
      "attachmentId": "7e7f532b-2427-4f45-84f4-67bdb24c5831",
      "resourcePath": "/contracts/attachments/contract_agreement.pdf",
      "attachmentDescription": "Signed contract agreement document",
      "fileName": "contract_agreement.pdf",
      "createdBy": "John Smith",
      "createdDate": "2023-05-16T14:30:00Z"
    }
  ],
  "status": "ACTIVE",
  "agreementCreatedDate": "2023-05-16T00:00:00.000+00:00",
  "contractTypeId": "3a4d3855-fe68-446d-99e3-90897ab1cc17",
  "contractTypeName": "Privacy Policy",
  "contractTypeNameKey": "PrivacyPolicy",
  "approvedDate": "2023-05-16",
  "expirationDate": "2024-05-15",
  "contractOwnerId": "8a732373-9713-4f93-98f6-cae431e61956",
  "contractOwner": "Antonio",
  "vendorContact": "antanio@microsoft.com",
  "approvers": "amara@microsoft.com, john.doe@company.com",
  "note": "Contract has been updated recently for Microsoft vendor",
  "cost": 10000,
  "url": "https://www.microsoft.com",
  "schemaId": "36e2d4a1-379f-4263-8e05-6e3a3207a834",
  "attributeValues": {
    "attributeSingleSelectValue.value21": [
      {
        "id": "c5c3167e-f8e2-4719-a0a1-491350507fee",
        "valueKey": "OneTrustApp.VRM.Contract.Attributes.e38d9fe7-a5b7-43b0-b79f-ed7940669c99",
        "value": "Recently Updated"
      }
    ]
  },
  "statusKey": "New"
}