Skip to main content

Get Shared Contracts List

Purpose

To get the list of contracts shared with the user.

Request Details

Request URL

https://contracts.zoho.com/api/v1/sharedcontracts

Authorization

Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6

Scope

contracts.contracts.GET, contracts.contracts.ALL

Possible Operation Types

ALL - Full access to contracts
GET - Get shared contracts

Sample Request

Copiedcurl "https://contracts.zoho.com/api/v1/sharedcontracts"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"

Response JSON Keys

  • owneruser(short)

    Represents the name of the contract owner.

  • modifiedTimestring

    Represents the time of modification.

  • apiNamestring

    Represents the name of the contract in the API.

  • contractTypeJSON Object

    Represents the API name and name of the contract type.

  • descriptionstring

    Represents the contract description.

  • amendmentsJSON Object

    Represents the changes made to the contract in all four amendment phases, namely Defaulft Contract, Amendment Contract, Renewal Contract and Extension Contract.

  • sequenceNumberJSON Object

    Represents the ordinal number of the amendment phase.

  • typenumber

    Represents the four amendment phases of the contract.

    ValueDescription
    1Default Contract
    2Amendment Contract
    3Renewal Contract
    4Extension Contract
  • startoptionnumber

    Represents the time when the contract starts.

    ValueDescription
    0Specific Date
    1Execution
    2Contract Start Date
  • endoptionnumber

    Represents the time when the contract ends.

    ValueDescription
    0Specific Date
    1On Condition
    2On Event
    3Month or Year
    4Fulfillment
  • docsourcenumber

    Represents the source of the contract document in the particular stage of the amendment cycle.

    ValueDescription
    1DOC
    2DOC_IMPORTED
    3PDF
    4NO_LETTER_IMPORTED
  • numbernumber

    Represents a unique number given to each contract amendment.

  • is currentboolean

    Represents whether any amendment is active for this contract or not.

    ValueDescription
    TrueYes
    FalseNo
  • stagestring

    Represents the API name and name of the particular stage in the contract.

  • systemstatusnumber

    Represents the reason for the termination of amendment.

    ValueDescription
    6Default
    7On Hold
    8Cancelled
    41Cancelled due to Termination
    42Cancelled due to Expiration
    43Cancelled due to Term Change
  • lastcyclenumbernumber

    Represents the cycle number of the previous amendment.

  • idstring

    Represents the unique ID of a contract amendment.

  • effectivedate & startdatestring

    Represents the date on which the contract amendment becomes active.

  • sourcenumber

    Represents the source of the contract.

  • isActivenumber

    Represents whether the contract is active.

    ValueDescription
    1Active
    0Deleted
    5Archived
  • intentnumber

    Represents the intent of the contract.

    ValueDescription
    0Others
    1Buy
    2Sell
  • taxOptionnumber

    Represents the tax to be paid by the contracting parties in the contract.

    ValueDescription
    0All Tax Included
    1As Per Payment Terms
  • partyAnumber

    Represents the contracting party in a contract.

    ValueDescription
    0My Company
    1Counterparty
  • isRenewableboolean

    Represents the contracting party in a contract.

    ValueDescription
    TrueRenewable
    FalseNon Renewable
  • requesterNamestring

    Represents the name and name of the user who initiates the contract.

  • contractTermboolean

    Represents the contracting party in a contract.

    ValueDescription
    TrueDefinite
    FalseIndefinite
  • systemStatusnumber

    Represents the status of the contract.

    ValueDescription
    12In Progress
    1Active
    9Terminated
    10Expired
    7On Hold
    3Termination Initiated
  • partyBnumber

    Represents the contracting party in a contract.

    ValueDescription
    0My Company
    1Counterparty
  • contractIDstring

    Represents the unique ID of the contract.

  • namestring

    Represents the name of the contract.

  • counterPartyJSON Object

    Represents the name and API name of the counterparty.

Possible Errors

INVALID_URL_PATTERNHTTP 404

Request URL is incorrect

Resolution: Specify a valid request URL. Refer to the Request URL section above.

OAUTH_SCOPE_MISMATCHHTTP 401

Unauthorized

Resolution: Client does not have contracts.contracts.GET scope. Create a new client with valid scope. Refer to the Scope section above.

NO_PERMISSIONHTTP 403

Permission denied to read

Resolution: The user does not have permission to read records. Contact your organization administrator.

INTERNAL_ERRORHTTP 500

Internal Server Error

Resolution: Unexpected and unhandled exception in the server.

INVALID_REQUEST_METHODHTTP 400

The HTTP request method is not a valid one.

Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to the Endpoints section above.

AUTHORIZATION_FAILEDHTTP 400

The user does not have sufficient privilege to read module details.

Resolution: The user does not have permission to retrieve module details. Contact your organization administrator.

Sample Response

Copied"contracts":[
    {
       "owner":{
          "displayName": String,
          "emailId": String,
          "id": String
       },
       "modifiedTime": String
       "apiName": String
       "contractType":{
          "apiName": String
          "name": String
       },
       "description": String
       "amendments":[
          {
             "sequenceNumber": Integer,
             "modifiedTime": String
             "type": Integer,
             "startOption": Integer,
             "endOption": Integer,
             "docSource": Integer,
             "number": Integer,
             "isCurrent": Boolean,
             "stage":{
                "apiName": String,
                "name": String
             },
             "systemStatus": Integer,
             "latestCycleNumber": Integer,
             "id": String,
             "effectiveDate": String,
             "startDate": String
          },
          {
             "sequenceNumber": Integer,
             "modifiedTime": String,
             "type": Integer,
             "startOption": Integer,
             "endOption": Integer,
             "docSource": Integer,
             "number": Integer,
             "isCurrent": Boolean,
             "stage":{
                "apiName": String,
                "name": String
             },
             "systemStatus": Integer
             "latestCycleNumber": Integer
             "id": String,
             "effectiveDate": String
             "startDate": String
          },
          {
             "sequenceNumber": Integer,
             "modifiedTime": String
             "type": Integer,
             "startOption": Integer,
             "endOption": Integer,
             "docSource": Integer,
             "number": Integer,
             "isCurrent": Boolean,
             "stage":{
                "apiName": String
                "name": String
             },
             "systemStatus": Integer,
             "latestCycleNumber": Integer,
             "id": String,
             "effectiveDate": String,
             "startDate": String
          }
       ],
       "source": Integer,
       "isActive": Integer,
       "intent": Integer,
       "partyA": Integer,
       "isRenewable": Boolean,
       "requesterName": String,
       "contractTerm": Boolean,
       "systemStatus": Integer,
       "partyB": Integer,
       "contractId": String,
       "name": String,
       "counterParty":{
          "organizationApiName": String,
          "name": String
       }
    },
]

LEGEND

type
    DEFAULT_CONTRACT = 1
    AMENDMENT_CONTRACT = 2
    RENEWAL_CONTRACT = 3
    EXTENSION_CONTRACT = 4       

startoption
           SPECIFIC_DATE = 0
           EXECUTION = 1
           CONTRACT_START_DATE = 2  

endoption
         SPECIFIC_DATE = 0
         ON_CONDITION = 1
         ON_EVENT = 2
         MONTH_OR_YEAR = 3
         FULFILLMENT = 4

docsource
         DOC = 1
         DOC_IMPORTED = 2
         PDF = 3
         NO_LETTER_IMPORTED = 4

systemstatus(amendment)
            DEFAULT = 6
            ON_HOLD = 7
            CANCELLED = 8
            CANCELLED_DUE_TO_TERMINATION = 41
            CANCELLED_DUE_TO_EXPIRATION = 42
            CANCELLED_DUE_TO_TERM_CHANGE = 43

isActive
        ACTIVE - 1
        DELETED - 0
        ARCHIVED - 5

intent
      OTHERS - 0
      BUY - 1
      SELL - 2

taxoption
         ALL_TAX_INCLUDED - 0
         AS_PER_PAYMENT_TERMS - 1

partyA
      MY_COMPANY - 0
      COUNTERPARTY - 1

systemstatus
            IN_PROGRESS - 12
            ACTIVE  - 1
            TERMINATED - 9
            EXPIRED - 10
            ON_HOLD - 7
            TERMINATION_INITIATED - 3

partyB
      MY_COMPANY - 0
      COUNTERPARTY - 1
 Zoho Contracts Developer Community