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.1/Deals/{deal_id}/Contact_Roles

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

To get multiple contact roles:
https://www.zohoapis.com/crm/v2.1/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

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

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":"4876876000000327001",
            "email":"patricia.boyle@zohocorp.com"
         },
         "Email":"krismarrier@gmail.com",
         "$currency_symbol":"DA",
         "$field_states":null,
         "Other_Phone":null,
         "Mailing_State":"MD",
         "Other_State":null,
         "$sharing_permission":"full_access",
         "Other_Country":null,
         "Last_Activity_Time":"2022-05-10T09:41:31+05:30",
         "Department":"Engineering",
         "Contact_Role":"4876876000000006879",
         "$state":"save",
         "Unsubscribed_Mode":null,
         "$process_flow":false,
         "Assistant":null,
         "Mailing_Country":"United States",
         "Data_Processing_Basis_Details":null,
         "id":"4876876000000333191",
         "Data_Source":"Sample Data",
         "$approved":true,
         "Reporting_To":null,
         "$approval":{
            "delegate":false,
            "approve":false,
            "reject":false,
            "resubmit":false
         },
         "Other_City":null,
         "$data_source_details":{
            
         },
         "Created_Time":"2021-08-09T09:52:23+05:30",
         "Change_Log_Time__s":"2022-03-24T12:55:48+05:30",
         "$wizard_connection_path":null,
         "$editable":true,
         "Home_Phone":null,
         "Created_By":{
            "name":"Patricia Boyle",
            "id":"4876876000000327001",
            "email":"patricia.boyle@zohocorp.com"
         },
         "Secondary_Email":null,
         "Description":null,
         "Vendor_Name":null,
         "Mailing_Zip":"21224",
         "$review_process":{
            "approve":false,
            "reject":false,
            "resubmit":false
         },
         "Twitter":"krismarrier_sample",
         "Other_Zip":null,
         "Mailing_Street":"228 Runamuck Pl #2808",
         "Salutation":null,
         "First_Name":"Kris",
         "Full_Name":"Kris Marrier (Sample)",
         "Asst_Phone":null,
         "Record_Image":"1e88b0d239abe7802ccfb5eb2e407ea3c5806a0fd610ef2bfb88ac4b6fdbeaf04fd8575efeef493fcd95b2f092127e5c4b292b6db6a0b9124dc06cf39701e59e20e0b5d84459b590606c3c9a084999a1",
         "Modified_By":{
            "name":"Patricia Boyle",
            "id":"4876876000000327001",
            "email":"patricia.boyle@zohocorp.com"
         },
         "$review":null,
         "Skype_ID":"kris_marrier",
         "Phone":"555-555-5555",
         "Account_Name":{
            "name":"King (Sample)",
            "id":"4876876000000333098"
         },
         "Email_Opt_Out":false,
         "Modified_Time":"2021-08-09T09:52:55+05:30",
         "Date_of_Birth":null,
         "Mailing_City":"Baltimore",
         "Unsubscribed_Time":null,
         "Title":"Quality Engineer",
         "Other_Street":null,
         "Mobile":"555-555-5555",
         "Territories":[
            {
               "$assigned":"manually",
               "can_remove":false,
               "$assigned_time":"2022-03-24T12:55:48+05:30",
               "id":"4876876000000893297",
               "$assigned_by":{
                  "name":"Patricia Boyle",
                  "id":"4876876000000327001"
               },
               "Name":"T1"
            }
         ],
         "$orchestration":false,
         "$stop_processing":false,
         "s":"2022-03-24T12:55:48+05:30",
         "Last_Name":"Marrier (Sample)",
         "$in_merge":false,
         "Lead_Source":"Trade Show",
         "Tag":[
            
         ],
         "Fax":null,
         "$approval_state":"approved"
      },
      {
         "Owner":{
            "name":"Patricia Boyle",
            "id":"4876876000000327001",
            "email":"patricia.boyle@zohocorp.com"
         },
         "Email":"brian@villa.com",
         "$currency_symbol":"DA",
         "$field_states":null,
         "Other_Phone":null,
         "Mailing_State":"Texas",
         "Other_State":null,
         "$sharing_permission":"full_access",
         "Other_Country":null,
         "Last_Activity_Time":"2022-05-20T12:40:04+05:30",
         "Department":null,
         "Contact_Role":"4876876000001283031",
         "$state":"save",
         "Unsubscribed_Mode":null,
         "$process_flow":false,
         "Assistant":null,
         "Mailing_Country":null,
         "Data_Processing_Basis_Details":null,
         "id":"4876876000001236004",
         "Data_Source":"Converted",
         "$approved":true,
         "Reporting_To":null,
         "$approval":{
            "delegate":false,
            "approve":false,
            "reject":false,
            "resubmit":false
         },
         "Other_City":null,
         "$data_source_details":null,
         "Created_Time":"2022-05-18T11:20:20+05:30",
         "Change_Log_Time__s":"2022-05-18T11:20:21+05:30",
         "$wizard_connection_path":null,
         "$editable":true,
         "Home_Phone":null,
         "Created_By":{
            "name":"Patricia Boyle",
            "id":"4876876000000327001",
            "email":"patricia.boyle@zohocorp.com"
         },
         "Secondary_Email":null,
         "Description":null,
         "Vendor_Name":null,
         "Mailing_Zip":null,
         "$review_process":{
            "approve":false,
            "reject":false,
            "resubmit":false
         },
         "Twitter":null,
         "Other_Zip":null,
         "Mailing_Street":null,
         "Salutation":null,
         "First_Name":"Briane",
         "Full_Name":"Briane Dolan",
         "Asst_Phone":null,
         "Record_Image":"1e88b0d239abe7802ccfb5eb2e407ea3ebb8ade588bd428d296ad50fe47332d4730c69ad5f7818fe5aab30888ea07cb048d45a7494e4ea160b20eddbc31d306f7267a9c4bb686957b8fb3cc7d925fa4f",
         "Modified_By":{
            "name":"Patricia Boyle",
            "id":"4876876000000327001",
            "email":"patricia.boyle@zohocorp.com"
         },
         "$review":null,
         "Skype_ID":null,
         "Phone":null,
         "Account_Name":{
            "name":"Villa Margarita",
            "id":"4876876000001236001"
         },
         "Email_Opt_Out":false,
         "Modified_Time":"2022-05-18T11:20:20+05:30",
         "Date_of_Birth":null,
         "Mailing_City":null,
         "Unsubscribed_Time":null,
         "Title":null,
         "Other_Street":null,
         "Mobile":null,
         "Territories":[
            {
               "$assigned":"automatically",
               "$assigned_time":"2022-05-18T11:20:21+05:30",
               "id":"4876876000000893297",
               "$assigned_by":null,
               "Name":"T1"
            }
         ],
         "$orchestration":false,
         "$stop_processing":false,
         "s":"2022-05-18T11:20:21+05:30",
         "Last_Name":"Dolan",
         "$in_merge":false,
         "Lead_Source":null,
         "Tag":[
            
         ],
         "Fax":null,
         "$approval_state":"approved"
      },
      {
         "Owner":{
            "name":"Patricia Boyle",
            "id":"4876876000000327001",
            "email":"patricia.boyle@zohocorp.com"
         },
         "Email":"tom.hanks@mkita.com",
         "$currency_symbol":"DA",
         "$field_states":null,
         "Other_Phone":null,
         "Mailing_State":"Texas",
         "Other_State":null,
         "$sharing_permission":"full_access",
         "Other_Country":null,
         "Last_Activity_Time":"2022-05-20T12:32:33+05:30",
         "Department":null,
         "Contact_Role":"4876876000000006871",
         "$state":"save",
         "Unsubscribed_Mode":null,
         "$process_flow":false,
         "Assistant":null,
         "Mailing_Country":null,
         "Data_Processing_Basis_Details":null,
         "id":"4876876000001288001",
         "Data_Source":"Manual",
         "$approved":true,
         "Reporting_To":null,
         "$approval":{
            "delegate":false,
            "approve":false,
            "reject":false,
            "resubmit":false
         },
         "Other_City":null,
         "$data_source_details":{
            
         },
         "Created_Time":"2022-05-20T12:31:33+05:30",
         "Change_Log_Time__s":null,
         "$wizard_connection_path":null,
         "$editable":true,
         "Home_Phone":null,
         "Created_By":{
            "name":"Patricia Boyle",
            "id":"4876876000000327001",
            "email":"patricia.boyle@zohocorp.com"
         },
         "Secondary_Email":null,
         "Description":null,
         "Vendor_Name":{
            "name":"SkyTech",
            "id":"4876876000001081586"
         },
         "Mailing_Zip":null,
         "$review_process":{
            "approve":false,
            "reject":false,
            "resubmit":false
         },
         "Twitter":null,
         "Other_Zip":null,
         "Mailing_Street":null,
         "Salutation":"Mr.",
         "First_Name":"Tom",
         "Full_Name":"Mr. Tom Hanks",
         "Asst_Phone":null,
         "Record_Image":null,
         "Modified_By":{
            "name":"Patricia Boyle",
            "id":"4876876000000327001",
            "email":"patricia.boyle@zohocorp.com"
         },
         "$review":null,
         "Skype_ID":null,
         "Phone":"8888889999",
         "Account_Name":{
            "name":"Villa Margarita",
            "id":"4876876000001236040"
         },
         "Email_Opt_Out":false,
         "Modified_Time":"2022-05-20T12:32:33+05:30",
         "Date_of_Birth":null,
         "Mailing_City":"Texas",
         "Unsubscribed_Time":null,
         "Title":"Evaluator",
         "Other_Street":null,
         "Mobile":null,
         "Territories":[
            {
               "$assigned":"automatically",
               "$assigned_time":"2022-05-20T12:31:33+05:30",
               "id":"4876876000000893297",
               "$assigned_by":null,
               "Name":"T1"
            }
         ],
         "$orchestration":false,
         "$stop_processing":false,
         "s":null,
         "Last_Name":"Hanks",
         "$in_merge":false,
         "Lead_Source":"Employee Referral",
         "Tag":[
            
         ],
         "Fax":null,
         "$approval_state":"approved"
      }
   ],
   "info":{
      "per_page":200,
      "count":3,
      "page":1,
      "more_records":false
   }
}

Show full

Show less

Top

CRM

Voice

Sign

Forms

Bigin

SalesIQ

Bookings

RouteIQ

Thrive

CRM Plus

Zakya

Campaigns

Voice

Sign

Forms

Social

Survey

SalesIQ

Sites

Backstage

PageSense

Marketing Automation

LandingPage

Webinar

LeadChain

Domains

CommunitySpaces

Thrive

Publish

Marketing Plus

Commerce

Zakya

Desk

Assist

Voice

SalesIQ

Bookings

FSM

Lens

Solo

Service Plus

Books

Expense

Sign

Inventory

Invoice

Billing

Payroll

Commerce

Checkout

Practice

Solo

Payments

Finance Plus

Mail

Voice

Sign

WorkDrive

Bookings

Cliq

Notebook

Meeting

Connect

Learn

Office Integrator

Writer

TeamInbox

ZeptoMail

Show

Tables

Sheet

Office Suite

Calendar

ToDo

PDF Editor

Workplace

Vani

Expense

Recruit

People