Get Collaborators

Purpose

To get the collaborators list and details of each collaborator in a contract.

Endpoints

GET /contracts/{contractApiName}/collaborators

Request Details

Request URL

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

Authorization

Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6

Scope

contracts.contracts.READ, contracts.contracts.ALL

Possible Operation Types

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

Sample Request

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

Response JSON Keys

collaboratorsJSON Array
Represents the list of all collaborators in the contract where each item contains the details of a collaborator.

modifiedTimestring
Represents the last modified time of the collaborator.

collaboratorActionJSON Array
Represents the activities related to the collaborator. Each item in the array represents the details of each activity and when it was performed. The following table explains the applicable values and their description of the "action" key.

Value Description
1 The collaborator has been notified via an email.
2 The collaborator has viewed the contract.
displayNamestring
Represents the name of the collaborator.

Value	Description
1	The collaborator has been notified via an email.
2	The collaborator has viewed the contract.

permissionsinteger
Represents the collaborator's permission in the contract document.
Value Description
7 Write
11 Comment and Fill Fields
9 Fill Fields Only
3 Comment Only
1 View Only

Value	Description
7	Write
11	Comment and Fill Fields
9	Fill Fields Only
3	Comment Only
1	View Only

addedByJSON Object
Represents the details of the user who added the collaborator.

addedTimestring
Represents the time the collaborator was added.

emailIdJSON Object
Represents the email ID of the collaborator.

modifiedByJSON Object
Represents the details of the user who last modified the collaborator.

idstring
Represents the unique ID of the collaborator.

zuidlong
Represents the Zoho User ID of the collaborator.

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{
    "collaborators": [
        {
            "modifiedTime": "Jul 18, 2023 12:24 PM",
            "collaboratorAction": [
                {
                    "actionTime": "Sep 15, 2023 02:37 PM",
                    "actionId": "4420000000580165",
                    "action": 1
                }
            ],
            "displayName": "Anna Hilla",
            "permissions": 7,
            "addedBy": {
                "displayName": "Smith Jones",
                "emailId": "smith.jones@zylker.com",
                "id": "596000000183025"
            },
            "addedTime": "Jun 29, 2023 09:10 AM",
            "emailId": "anna.hilla@zylker.com",
            "modifiedBy": {
                "displayName": "Smith Jones",
                "emailId": "smith.jones@zylker.com",
                "id": "596000000183025"
            },
            "id": "4420000000166067",
            "currentContractRole": "collaborator",
            "zuid": 77190576
        },
        {
            "modifiedTime": "Jul 19, 2023 11:21 AM",
            "collaboratorAction": [
                {
                    "actionTime": "Sep 15, 2023 02:37 PM",
                    "actionId": "4420000000580055",
                    "action": 1
                },
                {
                    "actionTime": "Sep 15, 2023 12:51 PM",
                    "actionId": "4420000000580915",
                    "action": 2
                }
            ],
            "displayName": "Steve Reeeder",
            "permissions": 1,
            "addedBy": {
                "displayName": "Smith Jones",
                "emailId": "smith.jones@zylker.com",
                "id": "596000000183025"            },
            "addedTime": "Jun 28, 2023 01:08 PM",
            "emailId": "stevereeder@zylker.com",
            "modifiedBy": {
                "displayName": "Smith Jones",
                "emailId": "smith.jones@zylker.com",
                "id": "596000000183025"
            },
            "id": "4420000000165503",
            "currentContractRole": "collaborator",
            "zuid": 77166011
        }
    ]
}