Skip to main content

Get Signers List

Purpose

To get the signers list and details of each signer of a contract.

Request Details

Request URL

https://contracts.zoho.com/api/v1/contracts/{contractApiName}/signers

Authorization

Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6

Scope

contracts.contracts.READ, contracts.contracts.ALL

Possible Operation Types

ALL - Full access to signer details
READ - Get signer details

Sample Request

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

Response JSON Keys

  • interpartySignersJSON Array

    Represents the list of signer representatives from the organization and counterparty side.

  • thirdpartySignersJSON Array

    Represents the list of other signers who don't represent the organization and counterparty side.

  • isOrgUserboolean

    Represents whether the signer is representative of the organization.

  • displayNamestring

    Represents the name of the signer.

  • emailIdstring

    Represents the email ID of the signer.

  • idstring

    Represents the unique ID of the signer maintained in Zoho Contracts.

  • zuidstring

    Represents the Zoho User ID of the organization representative signer.

  • orderinteger

    Represents the signer's ordinal number if the signing order is enabled.

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.READ 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{
   "signers":[
      {
         "interpartySigners":[
            {
               "isOrgUser":false,
               "displayName":"Tina Swift",
               "emailId":"tina.swift@zillum.com",
               "id":"683000000117943",
               "actions":[

               ],
               "order":0
            },
            {
               "isOrgUser":true,
               "displayName":"Smith Jones",
               "emailId":"smith.jones@zylker.com",
               "id":"596000000183025",
               "actions":[

               ],
               "zuid":73583287,
               "order":0
            }
         ],
         "thirdpartySigners":[

         ]
      }
   ]
}
 Zoho Contracts Developer Community