Gets one or more contacts
This method returns one or more contacts
associated with a Docusign account. You can also
retrieve contacts from connected cloud storage providers by using the
cloud_provider query parameter. By default,
contacts are retrieved from the Docusign account's
default address book.
To return a specific contact, use the contactId
query parameter. To return all contacts associated
with an account, omit this parameter.
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
The external account number (int) or account ID GUID.
The ID of a contact person in the account's address book.
Note: To return all contacts, omit this parameter. It is not required.
Query Parameters
(Optional) The cloud provider from which to retrieve the contacts. Valid values are:
roomsdocusignCore(default)
Response Body
application/json
application/json
curl -X GET "https://example.com/v2.1/accounts/string/contacts/string"{ "contacts": [ { "canManage": "string", "cloudProvider": "string", "cloudProviderContainerId": "string", "contactId": "string", "contactPhoneNumbers": [ { "phoneNumber": "string", "phoneType": "string" } ], "contactUri": "string", "emails": [ "string" ], "errorDetails": { "errorCode": "string", "message": "string" }, "isOwner": true, "name": "string", "notaryContactDetails": { "hasDocusignCertificate": "string", "jurisdictions": [ { "authorizedForIPen": "string", "authorizedForRon": "string", "jurisdictionId": "string", "jurisdictionName": "string" } ] }, "organization": "string", "roomContactType": "string", "shared": "string", "signingGroup": "string", "signingGroupName": "string" } ], "endPosition": "string", "nextUri": "string", "previousUri": "string", "resultSetSize": "string", "startPosition": "string", "totalSetSize": "string"}