Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
accountId string

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

contactId string

The unique identifier of a person in the contacts address book.

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Users::getContactById

Definitions Expand All | Collapse All

Contacts

contactId string

The unique identifier of a person in the contacts address book.

contactPhoneNumbers
[contactPhoneNumber]
contactUri string
emails
[string]
errorDetails errorDetails
name string
organization string
shared string

When set to true, this custom tab is shared.

signingGroup string
signingGroupName string

The display name for the signing group.

Maximum Length: 100 characters.

contactGetResponse

contacts
[Contacts]
endPosition string

The last position in the result set.

nextUri string

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.

previousUri string

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.

resultSetSize string

The number of results returned in this response.

startPosition string

Starting position of the current result set.

totalSetSize string

The total number of items in the search's result set. It will always be greater than or equal to the value of the resultSetSize field.

contactPhoneNumber

phoneNumber string
phoneType string

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

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>