Skip to navigation
How-to guides

How to retrieve the user's Docusign profile using an email address

View as Markdown

This topic demonstrates how to obtain the user’s Docusign profile information across all Docusign accounts by specifying the user’s email address.

Important: This endpoint can only be used by organizations that have purchased Docusign plans for both CLM and eSignature.

Note: If you only know the user’s User ID and do not know their email address, see How to retrieve the user’s Docusign profile using a User ID

Run this code example from our Quickstart or launcher projects: Bash, C#, Java, Node.js, PHP, PowerShell, Python, or Ruby.

Required data

Running the code in this how-to requires this data:

Data elementDescription
{BASE_PATH}A string value that forms the root of the URL required to make API calls. The base path value in the example code is set to target the developer environment at
https://<domain>/management
Where <domain> is api-d.docusign.net for the developer environment and api.docusign.net for production.
{EMAIL_ADDRESS}An email address for a user in the given organization.
{ORGANIZATION_ID}A GUID value that identifies the the organization that contains the account to which the user will be added. Copy the value from the Organization ID field in the Organization section of the Account Profile page.

Step 1. Obtain your OAuth token

To make the API call shown in this how-to, you need a valid OAuth access token. Docusign supports access tokens for three different recommended OAuth grant types: Public Authorization Code Grant, Confidential Authorization Code Grant, and JSON Web Token (JWT) Grant. Choose the OAuth grant type appropriate for your scenario. See Confidential Authorization Code Grant for guidance on your options to get an Confidential Authorization Code Grant OAuth token.

Docusign Admin OAuth access tokens are the same ones used for our eSignature REST API, although you must request one or more Docusign Admin scopes to call the Docusign Admin API. The endpoint call made in this how-to requires that you request the Docusign Admin-specific user_write scope when obtaining your access token.

See Docusign Admin Authentication for details and the full list of Docusign Admin scopes.

Three icons that represent the three methods a user can use to obtain an OAuth token: JSON Web Token (JWT), Public Authorization Code Grant (ACG), and Confidential Authorization Code grant

Step 2. Construct your API headers

After you have a valid OAuth access token, you are ready to construct the API headers that you will pass to the API call. Construct your headers like this, but make sure to substitute your valid OAuth access token for {ACCESS_TOKEN}.

declare -a Headers=('--header' "Authorization: Bearer ${ACCESS_TOKEN}" \
    '--header' "Accept: application/json" \
    '--header' "Content-Type: application/json")

Step 3. Call the Admin API

Now that you have constructed your request body, make a GET request to the Admin API. Here’s how you make the call, but make sure to substitute your Organization ID for {ORGANIZATION_ID}.

View the source code for this how-to on GitHub: Bash, C#, Java, Node.js, PHP, PowerShell, Python, or Ruby.

# Calculate date parameter to get users modified in the last 10 days
if date -v -10d &>/dev/null; then
    # Mac
    # modified_since=`date -v -10d '+%Y-%m-%dT%H:%M:%S%z'`
    modified_since=$(date -v -10d '+%Y-%m-%d')
else
    # Not a Mac
    # modified_since=`date --date='-10 days' '+%Y-%m-%dT%H:%M:%S%z'`
    modified_since=$(date --date='-10 days' '+%Y-%m-%d')
fi
response=$(mktemp /tmp/response-admin.XXXXXX)
# Call the Admin API
curl --request GET ${base_path}/v2.1/organizations/${ORGANIZATION_ID}/users/dsprofile?email=${EMAIL_ADDRESS} \
    "${Headers[@]}" \
    --output ${response}

Expected response

If you run this code example from our Quickstart or launcher projects, you should see a JSON response similar to this for each user.

Sample response
{
  "users": [
    {
      "id": "c316f86c-xxxx-xxxx-xxxx-6b39358381d2",
      "site_id": 1,
      "site_name": "Demo",
      "user_name": "Susan Signer",
      "first_name": "Susan",
      "last_name": "Signer",
      "user_status": "active",
      "default_account_id": "b71dbd28-xxxx-xxxx-xxxx-8d99842a7982",
      "default_account_name": "Acme",
      "language_culture": "en",
      "is_organization_admin": true,
      "created_on": "2020-09-30T21:39:06.527",
      "memberships": [
        {
          "email": "test@example.com",
          "account_id": "b71dbd28-xxxx-xxxx-xxxx-8d99842a7982",
          "external_account_id": "11xxxx33",
          "account_name": "Acme",
          "is_external_account": false,
          "status": "active",
          "product_permission_profiles": [
            {
              "product_id": "37f013eb-xxxx-xxxx-xxxx-357b39fdbd00",
              "product_name": "CLM",
              "permission_profiles": [
                {
                  "permission_profile_id": "0",
                  "permission_profile_name": "CLM Admin"
                }
              ]
            },
            {
              "product_id": "f6406c68-xxxx-xxxx-xxxx-64152a26fa83",
              "product_name": "ESign",
              "permission_profiles": [
                {
                  "permission_profile_id": "10xxxx31",
                  "permission_profile_name": "Account Administrator"
                }
              ]
            }
          ],
          "created_on": "2020-09-30T21:39:06.527",
          "ds_groups": [],
          "is_admin": true
        }
      ],
      "identities": [],
      "device_verification_enabled": true
    }
  ]
}

Next steps