docusign.user-custom-settings.get-custom-settings

Retrieves a list of custom user settings for a single user. Custom settings provide a flexible way to store and retrieve custom user information that can be used in your own system. Note: Custom user settings are not the same as user account settings. If the custom user settings you want to retrieve are grouped, you must include the X-DocuSign-User-Settings-Key header in the request: X-DocuSign-User-Settings-Key:group_name Where the group_name is your designated name for the group of customer user settings. If the X-DocuSign-User-Settings-Key header is not included, only the custom user settings that were added without a group are retrieved.

Retrieves the custom user settings for a specified user.

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.
userid	string	Yes	—	The ID of the user to access. Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.

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.
userid	string	Yes	—	The ID of the user to access. Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
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}/users/{userId}/custom_settings
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}/users/{userId}/custom_settings
* (any state)	fail	failed	Record the failure reason

API Usage

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

{
  "workflow_type": "docusign.user-custom-settings.get-custom-settings",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "userid": "value"
  }
}