Skip to navigation
How-to guides

How to create a workspace

View as Markdown

This topic demonstrates how to create a workspace using the Workspaces API.

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

Required data

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

Data elementDescription
{API_ACCOUNT_ID}A GUID value that identifies your account. This value is automatically generated by Docusign for any account you create. Copy the value from the API Account ID field on the Apps and Keys page.
{WORKSPACES_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>
Where <domain> is https://api-d.docusign.com/v1 for the developer environment and https://api.docusign.com/v1 for production.

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.

Wondering which grant type suits your integration? See Authenticate for guidance on your options to get an OAuth token.

Workspaces OAuth access tokens are the same ones used for our eSignature REST API, although you must request the signature scope and one or more Workspaces scopes to call the Workspaces API.

See Workspaces authentication for details and the full list of Workspaces 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. Construct the request body

Next, create the request body. The only body field required to create a workspace is name.

printf \
'{
    "name" : "'"${workspace_name}"'"
}' >> $request_data

Step 4. Call the Workspaces API

Now that you have constructed your API headers and request body, make a POST request to the Workspaces: createWorkspace endpoint and include the request body to create the workspace. Here’s how you make the call, but make sure to substitute your API account ID for <{account_id}>.

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

Status=$(curl -s -w "%{http_code}\n" -i \
     --request POST ${base_path}/accounts/${account_id}/workspaces \
    "${Headers[@]}" \
    --data-binary @${request_data} \
    --output ${response})

Expected response

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

Expected response
{"workspace_id":"090d5aa9-0fa9-4128-8380-137cc2cb24fc","name":"Example workspace","created_date":"2025-05-22T16:30:18.653","created_by_user_id":"2d80e7fa-b563-48c8-9199-dd12625f8b4d","workspace_owner_ids":["2d80e7fa-b563-48c8-9199-dd12625f8b4d"]}
Workspace created! ID: 090d5aa9-0fa9-4128-8380-137cc2cb24fc

Next steps