Get Counterparty Contacts
Purpose
To get the contact list of a counterparty.
Request Details
Request URL
https://contracts.zoho.com/api/v1/counterparties/{organizationApiName}/counterpartyusers?status=all
Authorization
Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6
Scope
contracts.contracts.READ, contracts.contracts.ALL
Possible Operation Types
ALL - Full access to counterparty contact details
READ - Get counterparty contact details
Sample Request
Copiedcurl "https://contracts.zoho.com/api/v1/counterparties/ABCcompany/counterpartyusers?status=all"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"
Response JSON Keys
- modifiedTimestring
Represents the time of modification.
- namestring
Represents the name of the counterparty contact.
- idstring
Represents the unique ID of the counterparty contact.
- addedBystring
Represents the user who created the counterparty contact.
- addedTimestring
Represents the time when the counterparty contact is created.
- modifiedByuser
Represents the last user who modified the counterparty contact.
- emailIdlong
Represents the email ID associated with the counterparty contact.
- statusstring
Represents the status of the counterparty contact.
Value Description active The counterparty contact is in use. stopped-processing The counterparty contact is not in use.
- organizationApiNamestring
Represents the name of the counterparty in the API.
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{
"counterpartyusers": [
{
"modifiedTime": String,
"displayName": String,
"addedBy": {{User short}}
"addedTime": String,
"emailId": String,
"counterParty": {
"organizationApiName": String,
"name": String
},
"modifiedBy": {{User short}}
"id": String,
"status": String
}
]
}