Users: getUsers

Required scopes: user_read

Returns information about the users in the organization.

Request

HTTP request

GET /v2/organizations/{organizationId}/users

Parameters

Parameter NameValueDescription
Path Parameters
organizationIdstring

The organization ID Guid

Responses

CodeDescriptionReference
200

OK

Users

SDK Method

Users::getUsers

Definitions

DocuSign.Account.Common.Models.RestApi.Response.PagingResponseProperties

Information about paging through results.

result_set_sizeinteger

Number of items in a result set (page).

result_set_start_positioninteger

Index of the first result in this set.

result_set_end_positioninteger

Index of the last result in this set.

total_set_sizeinteger

Total number of results.

nextstring

A URL to the next set of results.

previousstring

A URL to the previous set of results.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.OrganizationUserResponse

Information about a user.

idstring

The user's unique ID.

user_namestring

The full name of the user.

first_namestring

The user's first name.

last_namestring

The user's last name.

user_statusstring

The user's status. One of:

  • active
  • created
  • closed

membership_statusstring

The user's membership status. One of:

  • activation_required
  • activation_sent
  • active
  • closed
  • disabled

emailstring

The email address

created_onstring

The date the user's account was created.

membership_created_onstring

The date on which the user became a member of the organization.

Users

Methods to manage users in an account.

users[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.OrganizationUserResponse]

A list of users.

pagingDocuSign.Account.Common.Models.RestApi.Response.PagingResponseProperties

Information about paging though the responses.

}} />