Retrieves the list of users in the given workspace | Docusign

{
  "users": [
    {
      "user_id": "211e2d22-f070-4c8d-b6a7-ecb14ceb81b4",
      "email": "john.doe@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "role_id": "4a8e1b7c-2d5f-4c3a-9b6e-1f8a2c4d6e9b",
      "role_name": "Manage"
    },
    {
      "user_id": "3b2c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
      "email": "jane.smith@example.com",
      "first_name": "Jane",
      "last_name": "Smith",
      "role_id": "7f2a9e1c-5b8d-4f6a-a1c3-8e4b7d1a5c9f",
      "role_name": "Participate"
    },
    {
      "user_id": "4c3d5e6f-7a8b-9c0d-1e2f-3a4b5c6d7e8f",
      "email": "bob.johnson@example.com",
      "first_name": "Bob",
      "last_name": "Johnson",
      "role_id": "7f2a9e1c-5b8d-4f6a-a1c3-8e4b7d1a5c9f",
      "role_name": "Participate"
    }
  ],
  "result_set_size": 3,
  "start_position": 0,
  "end_position": 2,
  "total_row_count": 3
}

This operations retrieves the users in a workspace. Users sent envelopes or assigned tasks will automatically be added to the workspace with the Participate role.

Pagination is supported by passing start_position and count in the request. The response will include resultSetSize, start_position, and end_position which may be utilized for subsequent requests.

Required authentication scopes: dtr.rooms.read

Authentication

AuthorizationBearer

JWT Bearer token from Docusign authorization server

Path parameters

accountIdstringRequiredformat: "uuid"

The ID of the account

workspaceIdstringRequiredformat: "uuid"

The ID of the workspace

Query parameters

countintegerOptional

Number of workspace users to return. Defaults to the maximum which is 100.

start_positionintegerOptional

Position of the first item in the total results. Defaults to 0.

filterstringOptional

Returns workspace users filtered by Name and Email

sortenumOptional

Sorts results. Options are first_name_asc, first_name_desc, last_name_asc, last_name_desc, email_asc, email_desc. Defaults to last_name_desc

Response

The workspace user was successfully retrieved

userslist of objects or null

The user summary list. Includes the ID, name, and metadata such as the role ID and role name

result_set_sizeinteger or nullOptional

The number of users returned in the response. Always equal or less than the count of the request

start_positioninteger or nullOptional

Position of the first item in the total results

end_positioninteger or nullOptional

Position of the last item in the total results

total_row_countinteger or nullOptional

The total number of users in the workspace applicable to the request regardless of pagination. It may not always be computed

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error