Get users in organization

GET

/v2/organizations/:organizationId/users

GET

/Management/v2/organizations/:organizationId/users

curl https://api-d.docusign.net/Management/v2/organizations/organizationId/users \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "users": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "user_name": "string",
      "first_name": "string",
      "last_name": "string",
      "user_status": "string",
      "membership_status": "string",
      "email": "string",
      "created_on": "2024-01-15T09:30:00Z",
      "membership_created_on": "2024-01-15T09:30:00Z",
      "ds_groups": [
        {
          "ds_group_id": "00000000-0000-0000-0000-000000000000",
          "account_id": "00000000-0000-0000-0000-000000000000",
          "source_product_name": "string",
          "group_id": "string",
          "group_name": "string",
          "description": "string",
          "is_admin": true,
          "last_modified_on": "2024-01-15T09:30:00Z",
          "user_count": 1,
          "external_account_id": 1,
          "account_name": "string",
          "is_managed_by_scim": true
        }
      ],
      "membership_id": "00000000-0000-0000-0000-000000000000",
      "closed_on": "2024-01-15T09:30:00Z",
      "is_managed_by_scim": true,
      "is_membership_managed_by_scim": true,
      "license_type": "string",
      "membership_closed_on": "2024-01-15T09:30:00Z",
      "plan_name": "string",
      "subscription_id": "string"
    }
  ],
  "paging": {
    "result_set_size": 1,
    "result_set_start_position": 1,
    "result_set_end_position": 1,
    "total_set_size": 1,
    "next": "string",
    "previous": "string"
  }
}

Returns information about the users in an organization.

You must include at least one of the following query parameters in the request:

account_id: The ID of an account associated with the organization.
organization_reserved_domain_id: The ID of one of the organization’s reserved domains.
email: An email address associated with the users that you want to return.

Required authentication scopes: user_read.

Authentication

AuthorizationBearer

OAuth2 Access code Grant

Path parameters

organizationIdstringRequiredformat: "uuid"

The organization ID Guid

Query parameters

startintegerOptional

Index of first item to include in the response. The default value is 0.

takeintegerOptional

Page size of the response. The default value is 20.

endintegerOptional

Index of the last item to include in the response. Ignored if take parameter is specified.

emailstringOptional

Email address of the desired user. At least one of email, account_id or organization_reserved_domain_id must be specified.

email_user_name_likestringOptional

Selects users by pattern matching on the user's email address

statusstringOptional

Status.

membership_statusstringOptional

The user’s membership status. One of:

activation_required
activation_sent
active
closed
disabled

account_idstringOptionalformat: "uuid"

Select users that are members of the specified account. At least one of email, account_id or organization_reserved_domain_id must be specified.

organization_reserved_domain_idstringOptionalformat: "uuid"

Select users that are in the specified domain. At least one of email, account_id or organization_reserved_domain_id must be specified.

last_modified_sincestringOptional

Select users whose data have been modified since the date specified; account_id or organization_reserved_domain_id must be specified.

include_ds_groupsbooleanOptional

Select users with groups the users belong to; The organization must have entitlement AllowMultiApplication enabled.

include_licensebooleanOptional

When true: additional details about the user’s license will be included in the response; account_id must be specified and the account must have an IAM plan with licenses.

Response

userslist of objectsOptional

A list of users.

pagingobjectOptional