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.

Request

HTTP request

GET /v2.1/accounts/{accountId}/contacts/{contactId}

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

contactIdstring

(Optional) The id of a contact person in the account's address book.

Optional Query Parameters
cloud_providerstring

(Optional) The cloud provider from which to retrieve the contacts. Valid values are:

  • DocusignCore (default)
  • rooms

Responses

CodeDescriptionReference
200

Successful response.

contactGetResponse
400

Error encountered.

errorDetails

SDK Method

Users::getContactById

Definitions

contactGetResponse

This response object contains information about the contacts associated with an account.

contacts[Contacts]

A list of contacts.

endPositionstring

The last index position in the result set.

nextUristring

The URI for the next chunk of records based on the search request. It is null if this is the last set of results for the search.

previousUristring

The URI for the prior chunk of records based on the search request. It is null if this is the first set of results for the search.

resultSetSizestring

The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the totalSetSize.

startPositionstring

The starting index position of the current result set.

totalSetSizestring

The total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.

contactPhoneNumber

Details about the phone numbers associated with a specific contact.

phoneNumberstring

The contact's phone number.

Example: +12223334444

phoneTypestring

The type of phone number. Valid values are:

  • home
  • mobile
  • work
  • other
  • fax

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

Contacts

The Contacts resource enables you to manage the contact in an account's address book.

cloudProviderstring

The cloud service that provided the contact. Valid values are:

  • rooms
  • docusignCore (default)

cloudProviderContainerIdstring

The id of the container at the cloud provider. For example, this might be the room id for a DocuSign Transaction Room.

contactIdstring

The id of a contact person in the account's address book.

contactPhoneNumbers[contactPhoneNumber]

A list of the contact's phone numbers.

contactUristring

The URI for retrieving information about the contact.

emails[array]

The email address or addresses associated with the contact.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

isOwnerboolean

When true, the current user is the owner of the contact.

namestring

The name of the contact.

organizationstring

The name of the contact's organization.

sharedstring

When set to true, the contact is shared. For more information, see Shared Contacts.

signingGroupstring

If the contact belongs to a signing group, this property contains the signingGroupId.

signingGroupNamestring

The name of the signing group that the contact belongs to.

Examples

Generic JSON Response

Response
{
  "resultSetSize": "sample string 1",
  "startPosition": "sample string 2",
  "endPosition": "sample string 3",
  "totalSetSize": "sample string 4",
  "nextUri": "sample string 5",
  "previousUri": "sample string 6",
  "contacts": [
    {
      "signingGroupUsers": [
        {
          "userName": "sample string 1",
          "userId": "sample string 2",
          "email": "sample string 3",
          "userType": "sample string 4",
          "userStatus": "sample string 5",
          "uri": "sample string 6",
          "loginStatus": "sample string 7",
          "sendActivationEmail": "sample string 8",
          "activationAccessCode": "sample string 9",
          "errorDetails": {
            "errorCode": "SUCCESS",
            "message": ""
          }
        }
      ],
      "contactId": "sample string 1",
      "name": "sample string 2",
      "emails": [
        "sample string 1"
      ],
      "organization": "sample string 3",
      "shared": "sample string 4",
      "contactUri": "sample string 5",
      "signingGroup": "sample string 6",
      "signingGroupName": "sample string 7",
      "contactPhoneNumbers": [
        {
          "phoneNumber": "sample string 1",
          "phoneType": "sample string 2"
        }
      ],
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      }
    }
  ]
}
Generic XML Response

Response
<contactResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <contacts>
    <contact>
      <contactId>sample string 1</contactId>
      <contactPhoneNumbers xmlns:d4p1="http://schemas.datacontract.org/2004/07/API_REST.Models.v2">
        <d4p1:contactPhoneNumber>
          <d4p1:phoneNumber>sample string 1</d4p1:phoneNumber>
          <d4p1:phoneType>sample string 2</d4p1:phoneType>
        </d4p1:contactPhoneNumber>
      </contactPhoneNumbers>
      <contactUri>sample string 5</contactUri>
      <emails>
        <string>sample string 1</string>
      </emails>
      <errorDetails>
        <errorCode>sample string 1</errorCode>
        <message>sample string 2</message>
      </errorDetails>
      <name>sample string 2</name>
      <organization>sample string 3</organization>
      <shared>sample string 4</shared>
      <signingGroup>sample string 6</signingGroup>
      <signingGroupName>sample string 7</signingGroupName>
      <signingGroupUsers>
        <userInfo>
          <activationAccessCode>sample string 9</activationAccessCode>
          <email>sample string 3</email>
          <errorDetails>
            <errorCode>SUCCESS</errorCode>
            <message></message>
          </errorDetails>
          <loginStatus>sample string 7</loginStatus>
          <sendActivationEmail>sample string 8</sendActivationEmail>
          <uri>sample string 6</uri>
          <userId>sample string 2</userId>
          <userName>sample string 1</userName>
          <userStatus>sample string 5</userStatus>
          <userType>sample string 4</userType>
        </userInfo>
      </signingGroupUsers>
    </contact>
  </contacts>
</contactResponse> 
}} />