List users in group

GET

/v2.1/accounts/:accountId/groups/:groupId/users

GET

/restapi/v2.1/accounts/:accountId/groups/:groupId/users

curl https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/groups/GROUP_ID/users \
     -H "Authorization: Bearer <apiKey>"

{
  "endPosition": "sample string 1",
  "nextUri": "sample string 2",
  "previousUri": "sample string 3",
  "resultSetSize": "sample string 4",
  "startPosition": "sample string 5",
  "totalSetSize": "sample string 6",
  "users": [
    {
      "activationAccessCode": "sample string 1",
      "email": "sample string 2",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      },
      "loginStatus": "sample string 3",
      "sendActivationEmail": "sample string 4",
      "uri": "sample string 5",
      "userId": "sample string 6",
      "userName": "sample string 7",
      "userStatus": "sample string 8",
      "userType": "sample string 9"
    }
  ]
}

Retrieves a list of users in a group.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

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

groupIdstringRequired

The ID of the group being accessed.

Query parameters

countstringOptional

The maximum number of results to return.

Use start_position to specify the number of results to skip.

Valid values: 1 to 100

Default: 50

start_positionstringOptional

The zero-based index of the result from which to start returning results.

Use with count to limit the number of results.

The default value is 0.

Response

Successful response.

endPositionstringOptional

The last position in the result set.

nextUristringOptional

The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.

previousUristringOptional

The postal code for the billing address.

resultSetSizestringOptional

The number of results returned in this response.

startPositionstringOptional

Starting position of the current result set.

totalSetSizestringOptional

The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.

userslist of objectsOptional

Errors

400

Bad Request Error