UserCustomSettings

Retrieves the custom user settings for a specified user.

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.

get/v2.1/accounts/{accountId}/users/{userId}/custom_settings

Request

  • Base URL
    https://www.docusign.net/restapi
  • URL
    https://www.docusign.net/restapi/v2.1/accounts/{accountId}/users/{userId}/custom_settings
  • Auth
    none declared

Path parameters

accountIdstring required

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

userIdstring required

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.

Response

Successful response.

Changes

No recorded changes to this operation across all 39 revisions of this API.