DocuSign Momentum 2018DocuSign Momentum 2018

Returns users from the configured Connect service.

Request

HTTP request

GET /v2/accounts/{accountId}/connect/{connectId}/users

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID Guid.

connectIdstring

The ID of the custom Connect configuration being accessed.

Optional Query Parameters
countstring

Optional. Number of items to return.

email_substringstring

Filters the returned user records by the email address or a sub-string of email address.

list_included_usersstring

start_positionstring

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

statusstring

Filters the results by user status. You can specify a comma-separated list of the following statuses:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled

user_name_substringstring

Filters the user records returned by the user name or a sub-string of user name.

Responses

CodeDescriptionReference
200

Successful response.

integratedUserInfoList
400

Error encountered.

errorDetails

SDK Method

Connect::listUsers

Definitions

errorDetails
integratedUserInfoList
userInfo

Examples

Generic JSON Response
Generic XML Response