Get Signers List

Purpose

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

Endpoints

GET /contracts/{contractApiName}/signers

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 contract information
READ - Get signer information

Sample Request

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

Response JSON Keys

signersJSON Array
The array represents the details of all signer groups involved in the contract signing process. The signer groups organization representatives, counterparty representatives, other representatives, receivers, and in-person signer hosts.
interpartySignersJSON Array
The array represents the details of organization representatives and counterparty representatives associated with the contract.
receiversJSON Array
Represents the list of recipients who receive a copy of the contract after signing is completed. They do not participate in the signing process.
thirdpartySignersJSON Array
Represents the list of other representatives participate in signing the contract but do not represent either the organization or counterparty side.
isOrgUserboolean
Represents whether the signer is a representative of the organization.
displayNamestring
Represents the name of the organization representative, counterparty representative, other representative, or receiver.
emailIdstring
Represents the email ID of the organization representative, counterparty representative, other representative, or receiver.
idstring
Represents the unique ID of the organization or counterparty representatives maintained in Zoho Contracts.
orderinteger
Represents the signing order of the singers when the signing order is enabled.
hostJSON Object
Represents the details of the in-person signer hosts.
languagestring
Represents the signer's preferred language code for email notifications and the application user interface (e.g, "en" for English).
authenticationJSON Object
The array represents the authentication details of each signer to verify them before signing, such as the authentication type and corresponding information.
auth_typenumber
Represents the authentication type used to verify the signers.
Value Description
1 Email
2 SMS
3 Offline
country_codestring
Represents the country dialing code used for SMS authentication (e.g, "IN").
Note: When SMS authentication is selected, both the country code and phone number must be provided.
phone_nostring
Represents the phone number used for OTP authentication when SMS authentication is selected.
auth_codenumber
Represents the access code used for the Offline authentication (e.g, "678540").
Note: When the Offline authentication type is selected, the authentication code must contain 6 digits.

Sample Response

Copied{
  "signers": [
    {
      "receivers": [
        {
          "signerId": 3000000471101,
          "displayName": "John Smith",
          "emailId": "john.smith@zylker.com",
          "language": "en",
          "id": "3000000471110",
          "message": "",
          "actions": [],
          "order": 1,
          "authentication": {
            "auth_type": 3,
            "auth_code": "897654"
          }
        }
      ],
      "interpartySigners": [
        {
          "signerId": 3000000471201,
          "isOrgUser": false,
          "displayName": "Emma Brown",
          "host": {
            "displayName": "David Johnson",
            "emailId": "david.johnson@zylker.com",
            "id": "3000000471305"
          },
          "language": "en",
          "emailId": "emma.brown@zylker.com",
          "id": "3000000471312",
          "message": "",
          "actions": [],
          "order": 2,
          "authentication": {
            "phone_no": "9876543210",
            "country_code": "IN",
            "auth_type": 2
          }
        },
        {
          "signerId": 3000000471201,
          "isOrgUser": true,
          "displayName": "David Johnson",
          "language": "en",
          "emailId": "david.johnson@zylker.com",
          "id": "3000000471305",
          "message": "Please verify and sign at the earliest.",
          "actions": [],
          "zuid": 34987654,
          "order": 3,
          "authentication": {
            "auth_type": 1
          }
        }
      ],
      "thirdpartySigners": [
        {
          "signerId": 3000000471401,
          "displayName": "Sophia Wilson",
          "emailId": "sophia.wilson@externalmail.com",
          "language": "en",
          "id": "3000000471410",
          "message": "",
          "actions": [],
          "order": 4
        }
      ]
    }
  ]
}

Possible Errors

INVALID_URL_PATTERNHTTP 404

Request URL is incorrect. Specify a valid request URL.

Resolution: Provide a valid URL as mentioned in the Request URL section above.

OAUTH_SCOPE_MISMATCHHTTP 401

Unauthorized. The client does not have contracts.contracts.READ scope.

Resolution: Create a new client with valid scope. Refer to the Scope section above.

NO_PERMISSIONHTTP 403

Permission denied to create. The user does not have permission to create records.

Resolution: Contact the organization administrator to request the required access.

INTERNAL_ERRORHTTP 500

Internal Server Error.

Resolution: Unexpected and unhandled exception in the server. Try again later or contact the support team for assistance.

INVALID_REQUEST_METHODHTTP 400

The HTTP request method is not a valid one.

Resolution: Specify a valid request method as specified in the Endpoints section above.

AUTHORIZATION_FAILEDHTTP 400

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

Resolution: Contact the organization administrator to request the required access.

Value	Description
1	Email
2	SMS
3	Offline