docusign.contacts.get-contact-by-id

This method returns one or more contacts associated with a Docusign account. You can also retrieve contacts from connected [cloud storage][CloudStorage] 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. [CloudStorage]: /docs/esign-rest-api/reference/cloudstorage/

Gets one or more contacts.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
contactid	string	Yes	—	The ID of a contact person in the account's address book. Note: To return all contacts, omit this parameter. It is not required.
cloud_provider	string	No	—	(Optional) The cloud provider from which to retrieve the contacts. Valid values are: - rooms - docusignCore (default)

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
contactid	string	Yes	—	The ID of a contact person in the account's address book. Note: To return all contacts, omit this parameter. It is not required.
cloud_provider	string	No	—	(Optional) The cloud provider from which to retrieve the contacts. Valid values are: - rooms - docusignCore (default)
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call GET /v2.1/accounts/{accountId}/contacts/
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform GET /v2.1/accounts/{accountId}/contacts/
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.contacts.get-contact-by-id",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "contactid": "value"
  }
}