Skip to content

DocuSign: Gets one or more contacts

DocuSign esignature.esignatureContactsGetContactById: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_contacts_getcontactbyid

Provider route: GET /restapi/v2.1/accounts/{accountId}/contacts/{contactId}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureContactsGetContactById"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignatureContactsGetContactById(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_contacts_get_contact_by_id(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
path.contactIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.cloud_providerstringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Gets one or more contacts — response body

Referenced models: Gets one or more contacts — response body

Gets one or more contacts — response body
FieldTypePresenceDescription and constraints
$objectRootThis response object contains information about the contacts associated with an account.
contactsarrayOptionalA list of contacts.
contacts[]ModelEach itemExpand Deletes a contact — response body — contacts item
endPositionstringOptionalThe last index position in the result set.
nextUristringOptionalThe 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.
previousUristringOptionalThe 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.
resultSetSizestringOptionalThe 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`.
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.

Referenced models: Deletes a contact — response body — contacts item

Deletes a contact — response body — contacts item
FieldTypePresenceDescription and constraints
$objectRoot
canManagestringOptional
cloudProviderstringOptionalThe cloud service that provided the contact. Valid values are:

- `rooms`
- `docusignCore` (default)

<!-- Future:

- `Box`
- `GoogleDrive`
- `Dropbox`
- `SalesForce`
- `SkyDrive`

-->
cloudProviderContainerIdstringOptionalThe ID of the container at the cloud provider. For example, this might be the room ID for a Docusign Transaction Room.
contactIdstringOptionalThe ID of a contact person in the account's address book.
contactPhoneNumbersarrayOptionalA list of the contact's phone numbers.

**Note:** The phone numbers associated with shared contacts do not display to users other than the user who added the contact. Additionally, in the following scenarios, the phone number of a shared contact does not populate automatically for anyone other than the user who added the contact:

- Sending an envelope by using SMS
- Using phone authentication

You must ask the user who added the contact for the phone number and then manually enter it into the authentication box.
contactPhoneNumbers[]ModelEach itemExpand Deletes a contact — response body — contacts item contact Phone Numbers item
contactUristringOptionalThe URI for retrieving information about the contact.
emailsarrayOptionalAn array of email addresses.
emails[]stringEach item
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
isOwnerbooleanOptional
namestringOptionalThe name of the contact.
notaryContactDetailsModelOptionalExpand Deletes a contact — response body — contacts item notary Contact Details
organizationstringOptional
roomContactTypestringOptional
sharedstringOptionalWhen **true,** this contact is shared.
signingGroupstringOptionalThe ID of the signing group.
signingGroupNamestringOptionalOptional. The name of the signing group.

Maximum Length: 100 characters.

Referenced models: Deletes a contact — response body — contacts item contact Phone Numbers item, Locks a template — response body — error Details, Deletes a contact — response body — contacts item notary Contact Details

Deletes a contact — response body — contacts item contact Phone Numbers item
FieldTypePresenceDescription and constraints
$objectRootDetails about the phone numbers associated with a specific contact.
phoneNumberstringOptionalThe contact's phone number.

Example: `+12223334444`
phoneTypestringOptionalThe type of phone number. Valid values are:

- `home`
- `mobile`
- `work`
- `other`
- `fax`
Locks a template — response body — error Details
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.
Deletes a contact — response body — contacts item notary Contact Details
FieldTypePresenceDescription and constraints
$objectRoot
hasDocusignCertificatestringOptional
jurisdictionsarrayOptional
jurisdictions[]ModelEach itemExpand Deletes a contact — response body — contacts item notary Contact Details jurisdictions item

Referenced models: Deletes a contact — response body — contacts item notary Contact Details jurisdictions item

Deletes a contact — response body — contacts item notary Contact Details jurisdictions item
FieldTypePresenceDescription and constraints
$objectRoot
authorizedForIPenstringOptional
authorizedForRonstringOptional
jurisdictionIdstringOptionalThe ID of the jurisdiction.
The following jurisdictions
are supported:

- `5 - California`
- `6 - Colorado`
- `9 - Florida`
- `10 - Georgia`
- `12 - Idaho`
- `13 - Illinois`
- `14 - Indiana`
- `15 - Iowa`
- `17 - Kentucky`
- `23 - Minnesota`
- `25 - Missouri`
- `30 - New Jersey`
- `32 - New York`
- `33 - North Carolina`
- `35 - Ohio`
- `37 - Oregon`
- `38 - Pennsylvania`
- `40 - South Carolina`
- `43 - Texas`
- `44 - Utah`
- `47 - Washington`
- `48 - West Virginia`
- `49 - Wisconsin`
- `62 - Florida Commissioner of Deeds`
jurisdictionNamestringOptional

SDK function policy ID: docusign.esignature_contacts_getcontactbyid. Catalog operation: esignature:Contacts_GetContactById. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.