Get Contact Roles of a Specific Deal

Purpose

To get the details of contact roles associated with a specific deal

Endpoints

GET /Deals/{deal_id}/Contact_Roles/{contact_id}

GET /Deals/{deal_id}/Contact_Roles?ids={contact_id1,contact_id2,..}

Request Details

Request URL

https://www.zohoapis.com/crm/v2/Deals/{deal_id}/Contact_Roles

To get a specific contact role:
https://www.zohoapis.com/crm/v2/Deals/{deal_id}/Contact_Roles/{contact_id}

To get multiple contact roles:
https://www.zohoapis.com/crm/v2/Deals/{deal_id}/Contact_Roles?ids={contact_id1,contact_id2,...}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.modules.ALL
(or)
scope=ZohoCRM.modules.contacts.{operation_type}
(and)
scope=ZohoCRM.modules.deals.{operation_type}

Possible operation types

ALL - Full access to records
READ - Read records

Parameters

idsstring, optional
Specify comma-separated unique IDs of the contact roles.

Sample Request

Curl Csharp Node JS

Copiedcurl "https://www.zohoapis.com/crm/v2/Deals/4150868000003384003/Contact_Roles"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"

3.0.0

Copied//Get instance of ContactRolesOperations Class
ContactRolesOperations contactRolesOperations = new ContactRolesOperations();
//Call GetContactRole method that takes contactRoleId as parameter
APIResponse<ResponseHandler> response = contactRolesOperations.GetContactRole(contactRoleId);

1.0.0

Copied//Get instance of ContactRolesOperations Class
let contactRolesOperations = new ContactRolesOperations();
//Call getContactRole method that takes contactRoleId as parameter
let response = await contactRolesOperations.getContactRole(contactRoleId);

Response JSON keys

Contact_Rolestring
Represents the unique ID of the contact role.
idstring
Represents the unique ID of the contact.

Possible Errors

INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoCRM.modules.contacts.READ scope. Create a new client with valid scope. Refer to scope section above.
NO_PERMISSIONHTTP 403
Permission denied to read records
Resolution: The user does not have permission to read records in Deals or Contacts module. Contact your system administrator.
INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team.
INVALID_REQUEST_METHODHTTP 400
The http request method type 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 endpoints section above.
AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to read records
Resolution: The user does not have the permission to read records. Contact your system administrator.
INVALID_DATAHTTP 400
the related id given seems to be invalid
Resolution: Specify a valid {deal_id}. To retrieve valid record IDs, refer to Get Records API.

Sample Response

Copied{
  "data": [
    {
      "Owner": {
        "name": "Patricia Boyle",
        "id": "4150868000000225013",
        "email": "patricia@zylker.com"
      },
      "Email": null,
      "$currency_symbol": "DA",
      "Visitor_Score": null,
      "Other_Phone": null,
      "Mailing_State": null,
      "Other_State": null,
      "Other_Country": null,
      "Last_Activity_Time": null,
      "Department": null,
      "Contact_Role": "4150868000003611004",
      "$state": "save",
      "Unsubscribed_Mode": null,
      "$process_flow": false,
      "Assistant": null,
      "Exchange_Rate": 1,
      "Currency": "DZD",
      "Mailing_Country": null,
      "Data_Processing_Basis_Details": null,
      "id": "4150868000000369017",
      "Data_Source": "API",
      "$approved": true,
      "sample123": null,
      "Reporting_To": null,
      "$approval": {
        "delegate": false,
        "approve": false,
        "reject": false,
        "resubmit": false
      },
      "First_Visited_URL": null,
      "Days_Visited": null,
      "Other_City": null,
      "Negative_Touch_Point_Score": 0,
      "$data_source_details": {},
      "Created_Time": "2019-09-11T10:20:32+05:30",
      "$editable": true,
      "Positive_Touch_Point_Score": 0,
      "Last_Contacted_On": null,
      "Home_Phone": null,
      "Score": 0,
      "Negative_Score": 0,
      "Last_Visited_Time": null,
      "Created_By": {
        "name": "Patricia Boyle",
        "id": "4150868000000225013",
        "email": "patricia@zylker.com"
      },
      "Secondary_Email": null,
      "Touch_Point_Score": 0,
      "Positive_Score": 0,
      "Description": null,
      "Vendor_Name": null,
      "Mailing_Zip": null,
      "Number_Of_Chats": null,
      "$review_process": {
        "approve": false,
        "reject": false,
        "resubmit": false
      },
      "Twitter": null,
      "Other_Zip": null,
      "Mailing_Street": null,
      "Average_Time_Spent_Minutes": null,
      "Salutation": null,
      "First_Name": null,
      "Full_Name": "Hermione",
      "Asst_Phone": null,
      "Record_Image": null,
      "Modified_By": {
        "name": "Patricia Boyle",
        "id": "4150868000000225013",
        "email": "patricia@zylker.com"
      },
      "$review": null,
      "Skype_ID": null,
      "Phone": null,
      "Account_Name": null,
      "Email_Opt_Out": false,
      "Modified_Time": "2019-09-11T10:20:32+05:30",
      "Date_of_Birth": null,
      "Mailing_City": null,
      "Unsubscribed_Time": null,
      "Title": null,
      "Other_Street": null,
      "Mobile": null,
      "Territories": null,
      "$orchestration": false,
      "$stop_processing": false,
      "First_Visited_Time": null,
      "Last_Name": "Hermione",
      "Layout": {
        "name": "Standard",
        "id": "4150868000000091033"
      },
      "$in_merge": false,
      "Referrer": null,
      "Lead_Source": null,
      "Tag": [],
      "Fax": null,
      "$approval_state": "approved"
    },
    {
      "Owner": {
        "name": "Patricia Boyle",
        "id": "4150868000000225013",
        "email": "patricia@zylker.com"
      },
      "Email": null,
      "$currency_symbol": "DA",
      "Visitor_Score": null,
      "Other_Phone": null,
      "Mailing_State": null,
      "Other_State": null,
      "Other_Country": null,
      "Last_Activity_Time": null,
      "Department": null,
      "Contact_Role": "4150868000003611004",
      "$state": "save",
      "Unsubscribed_Mode": null,
      "$process_flow": false,
      "Assistant": null,
      "Exchange_Rate": 1,
      "Currency": "DZD",
      "Mailing_Country": null,
      "Data_Processing_Basis_Details": null,
      "id": "4150868000000369023",
      "Data_Source": "API",
      "$approved": true,
      "sample123": null,
      "Reporting_To": null,
      "$approval": {
        "delegate": false,
        "approve": false,
        "reject": false,
        "resubmit": false
      },
      "First_Visited_URL": null,
      "Days_Visited": null,
      "Other_City": null,
      "Negative_Touch_Point_Score": 0,
      "$data_source_details": {},
      "Created_Time": "2019-09-11T10:20:42+05:30",
      "$editable": true,
      "Positive_Touch_Point_Score": 0,
      "Last_Contacted_On": null,
      "Home_Phone": null,
      "Score": 0,
      "Negative_Score": 0,
      "Last_Visited_Time": null,
      "Created_By": {
        "name": "Patricia Boyle",
        "id": "4150868000000225013",
        "email": "patricia@zylker.com"
      },
      "Secondary_Email": null,
      "Touch_Point_Score": 0,
      "Positive_Score": 0,
      "Description": null,
      "Vendor_Name": null,
      "Mailing_Zip": null,
      "Number_Of_Chats": null,
      "$review_process": {
        "approve": false,
        "reject": false,
        "resubmit": false
      },
      "Twitter": null,
      "Other_Zip": null,
      "Mailing_Street": null,
      "Average_Time_Spent_Minutes": null,
      "Salutation": null,
      "First_Name": null,
      "Full_Name": "Hermione",
      "Asst_Phone": null,
      "Record_Image": null,
      "Modified_By": {
        "name": "Patricia Boyle",
        "id": "4150868000000225013",
        "email": "patricia@zylker.com"
      },
      "$review": null,
      "Skype_ID": null,
      "Phone": null,
      "Account_Name": null,
      "Email_Opt_Out": false,
      "Modified_Time": "2019-09-11T10:20:42+05:30",
      "Date_of_Birth": null,
      "Mailing_City": null,
      "Unsubscribed_Time": null,
      "Title": null,
      "Other_Street": null,
      "Mobile": null,
      "Territories": null,
      "$orchestration": false,
      "$stop_processing": false,
      "First_Visited_Time": null,
      "Last_Name": "Hermione",
      "Layout": {
        "name": "Standard",
        "id": "4150868000000091033"
      },
      "$in_merge": false,
      "Referrer": null,
      "Lead_Source": null,
      "Tag": [],
      "Fax": null,
      "$approval_state": "approved"
    },
    {
      "Owner": {
        "name": "Patricia Boyle",
        "id": "4150868000000225013",
        "email": "patricia@zylker.com"
      },
      "Email": null,
      "$currency_symbol": "DA",
      "Visitor_Score": null,
      "Other_Phone": null,
      "Mailing_State": null,
      "Other_State": null,
      "Other_Country": null,
      "Last_Activity_Time": null,
      "Department": null,
      "Contact_Role": "4150868000003611004",
      "$state": "save",
      "Unsubscribed_Mode": null,
      "$process_flow": false,
      "Assistant": null,
      "Exchange_Rate": 1,
      "Currency": "DZD",
      "Mailing_Country": null,
      "Data_Processing_Basis_Details": null,
      "id": "4150868000000369029",
      "Data_Source": "API",
      "$approved": true,
      "sample123": null,
      "Reporting_To": null,
      "$approval": {
        "delegate": false,
        "approve": false,
        "reject": false,
        "resubmit": false
      },
      "First_Visited_URL": null,
      "Days_Visited": null,
      "Other_City": null,
      "Negative_Touch_Point_Score": 0,
      "$data_source_details": {},
      "Created_Time": "2019-09-11T10:20:56+05:30",
      "$editable": true,
      "Positive_Touch_Point_Score": 0,
      "Last_Contacted_On": null,
      "Home_Phone": null,
      "Score": 0,
      "Negative_Score": 0,
      "Last_Visited_Time": null,
      "Created_By": {
        "name": "Patricia Boyle",
        "id": "4150868000000225013",
        "email": "patricia@zylker.com"
      },
      "Secondary_Email": null,
      "Touch_Point_Score": 0,
      "Positive_Score": 0,
      "Description": null,
      "Vendor_Name": null,
      "Mailing_Zip": null,
      "Number_Of_Chats": null,
      "$review_process": {
        "approve": false,
        "reject": false,
        "resubmit": false
      },
      "Twitter": null,
      "Other_Zip": null,
      "Mailing_Street": null,
      "Average_Time_Spent_Minutes": null,
      "Salutation": null,
      "First_Name": null,
      "Full_Name": "Hermione",
      "Asst_Phone": null,
      "Record_Image": null,
      "Modified_By": {
        "name": "Patricia Boyle",
        "id": "4150868000000225013",
        "email": "patricia@zylker.com"
      },
      "$review": null,
      "Skype_ID": null,
      "Phone": null,
      "Account_Name": null,
      "Email_Opt_Out": false,
      "Modified_Time": "2019-09-11T10:20:56+05:30",
      "Date_of_Birth": null,
      "Mailing_City": null,
      "Unsubscribed_Time": null,
      "Title": null,
      "Other_Street": null,
      "Mobile": null,
      "Territories": null,
      "$orchestration": false,
      "$stop_processing": false,
      "First_Visited_Time": null,
      "Last_Name": "Hermione",
      "Layout": {
        "name": "Standard",
        "id": "4150868000000091033"
      },
      "$in_merge": false,
      "Referrer": null,
      "Lead_Source": null,
      "Tag": [],
      "Fax": null,
      "$approval_state": "approved"
    },
    {
      "Owner": {
        "name": "Patricia Boyle",
        "id": "4150868000000225013",
        "email": "patricia@zylker.com"
      },
      "Email": null,
      "$currency_symbol": "DA",
      "Visitor_Score": null,
      "Other_Phone": null,
      "Mailing_State": null,
      "Other_State": null,
      "Other_Country": null,
      "Last_Activity_Time": null,
      "Department": null,
      "Contact_Role": "4150868000003611004",
      "$state": "save",
      "Unsubscribed_Mode": null,
      "$process_flow": false,
      "Assistant": null,
      "Exchange_Rate": 1,
      "Currency": "DZD",
      "Mailing_Country": null,
      "Data_Processing_Basis_Details": null,
      "id": "4150868000000369035",
      "Data_Source": "API",
      "$approved": true,
      "sample123": null,
      "Reporting_To": null,
      "$approval": {
        "delegate": false,
        "approve": false,
        "reject": false,
        "resubmit": false
      },
      "First_Visited_URL": null,
      "Days_Visited": null,
      "Other_City": null,
      "Negative_Touch_Point_Score": 0,
      "$data_source_details": {},
      "Created_Time": "2019-09-11T10:21:26+05:30",
      "$editable": true,
      "Positive_Touch_Point_Score": 0,
      "Last_Contacted_On": null,
      "Home_Phone": null,
      "Score": 0,
      "Negative_Score": 0,
      "Last_Visited_Time": null,
      "Created_By": {
        "name": "Patricia Boyle",
        "id": "4150868000000225013",
        "email": "patricia@zylker.com"
      },
      "Secondary_Email": null,
      "Touch_Point_Score": 0,
      "Positive_Score": 0,
      "Description": null,
      "Vendor_Name": null,
      "Mailing_Zip": null,
      "Number_Of_Chats": null,
      "$review_process": {
        "approve": false,
        "reject": false,
        "resubmit": false
      },
      "Twitter": null,
      "Other_Zip": null,
      "Mailing_Street": null,
      "Average_Time_Spent_Minutes": null,
      "Salutation": null,
      "First_Name": null,
      "Full_Name": "Hermione",
      "Asst_Phone": null,
      "Record_Image": null,
      "Modified_By": {
        "name": "Patricia Boyle",
        "id": "4150868000000225013",
        "email": "patricia@zylker.com"
      },
      "$review": null,
      "Skype_ID": null,
      "Phone": null,
      "Account_Name": null,
      "Email_Opt_Out": false,
      "Modified_Time": "2019-09-11T10:21:26+05:30",
      "Date_of_Birth": null,
      "Mailing_City": null,
      "Unsubscribed_Time": null,
      "Title": null,
      "Other_Street": null,
      "Mobile": null,
      "Territories": null,
      "$orchestration": false,
      "$stop_processing": false,
      "First_Visited_Time": null,
      "Last_Name": "Hermione",
      "Layout": {
        "name": "Standard",
        "id": "4150868000000091033"
      },
      "$in_merge": false,
      "Referrer": null,
      "Lead_Source": null,
      "Tag": [],
      "Fax": null,
      "$approval_state": "approved"
    },
    {
      "Owner": {
        "name": "Patricia Boyle",
        "id": "4150868000000225013",
        "email": "patricia@zylker.com"
      },
      "Email": null,
      "$currency_symbol": "DA",
      "Visitor_Score": null,
      "Other_Phone": null,
      "Mailing_State": null,
      "Other_State": null,
      "Other_Country": null,
      "Last_Activity_Time": "2020-11-18T11:42:05+05:30",
      "Department": null,
      "Contact_Role": null,
      "$state": "save",
      "Unsubscribed_Mode": null,
      "$process_flow": false,
      "Assistant": null,
      "Exchange_Rate": 3,
      "Currency": "DZD",
      "Mailing_Country": null,
      "Data_Processing_Basis_Details": null,
      "id": "4150868000003283024",
      "Data_Source": "Manual",
      "$approved": true,
      "sample123": null,
      "Reporting_To": null,
      "$approval": {
        "delegate": false,
        "approve": false,
        "reject": false,
        "resubmit": false
      },
      "First_Visited_URL": null,
      "Days_Visited": null,
      "Other_City": null,
      "Negative_Touch_Point_Score": 0,
      "$data_source_details": null,
      "Created_Time": "2020-10-22T20:10:58+05:30",
      "$editable": true,
      "Positive_Touch_Point_Score": 0,
      "Last_Contacted_On": null,
      "Home_Phone": null,
      "Score": 0,
      "Negative_Score": 0,
      "Last_Visited_Time": null,
      "Created_By": {
        "name": "Patricia Boyle",
        "id": "4150868000000225013",
        "email": "patricia@zylker.com"
      },
      "Secondary_Email": null,
      "Touch_Point_Score": 0,
      "Positive_Score": 0,
      "Description": null,
      "Vendor_Name": null,
      "Mailing_Zip": null,
      "Number_Of_Chats": null,
      "$review_process": {
        "approve": false,
        "reject": false,
        "resubmit": false
      },
      "Twitter": null,
      "Other_Zip": null,
      "Mailing_Street": null,
      "Average_Time_Spent_Minutes": null,
      "Salutation": null,
      "First_Name": null,
      "Full_Name": "Patricia Boyle",
      "Asst_Phone": null,
      "Record_Image": null,
      "Modified_By": {
        "name": "Patricia Boyle",
        "id": "4150868000000225013",
        "email": "patricia@zylker.com"
      },
      "$review": null,
      "Skype_ID": null,
      "Phone": null,
      "Account_Name": null,
      "Email_Opt_Out": false,
      "Modified_Time": "2020-10-22T20:11:08+05:30",
      "Date_of_Birth": null,
      "Mailing_City": null,
      "Unsubscribed_Time": null,
      "Title": null,
      "Other_Street": null,
      "Mobile": null,
      "Territories": null,
      "$orchestration": false,
      "$stop_processing": false,
      "First_Visited_Time": null,
      "Last_Name": "Patricia Boyle",
      "Layout": {
        "name": "Standard",
        "id": "4150868000000091033"
      },
      "$in_merge": false,
      "Referrer": null,
      "Lead_Source": null,
      "Tag": [],
      "Fax": null,
      "$approval_state": "approved"
    }
  ],
  "info": {
    "per_page": 200,
    "count": 5,
    "page": 1,
    "more_records": false
  }
}