__INITIALS__
This method returns a list of users who have sent PowerForms.
GET /restapi/v2.1/accounts/{accountId}/powerforms/senders| Parameter Name | Value | Description |
|---|---|---|
| Path Parameters | ||
| accountId | string | The external account number (int) or account ID GUID. |
| Optional Query Parameters | ||
| start_position | string | The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image. |
| Code | Description | Reference |
|---|---|---|
| 200 | Successful response. | powerFormSendersResponse |
| 400 | Error encountered. | errorDetails |
This object describes errors that occur. It is only valid for responses and ignored in requests. | ||
errorCode | string | The code associated with the error condition. |
message | string | A brief message describing the error condition. |
This object includes information about the users who have sent PowerForms. | ||
endPosition | integer | The last index position in the result set. |
nextUri | string | The URI for the next chunk of records based on the search request. It is |
powerFormSenders | [userInfo] | An array of |
previousUri | string | The URI for the prior chunk of records based on the search request. It is |
resultSetSize | integer | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the |
startPosition | integer | The starting index position of the current result set. |
totalSetSize | integer | The total number of items in the result set. This value is always greater than or equal to the value of |
accountId | string | The external account number (int) or account ID GUID. |
accountName | string | The name on the account. |
activationAccessCode | string | Access code provided to the user to activate the account. |
email | string | |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
loginStatus | string | Boolean value that indicates whether the user is currently logged in or not. |
membershipId | string | The user's membership ID. |
sendActivationEmail | string | When set to true, specifies that an activation email be sent to the user. |
uri | string | A URI containing the user ID. |
userId | string | The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, |
userName | string | The name of the user. |
userStatus | string | Status of the user's account. One of:
|
userType | string | The type of user, for example |
{
"powerFormSenders": [
{
"userName": "sample string 1",
"userId": "sample string 2",
"email": "sample string 3",
"userType": "sample string 4",
"userStatus": "sample string 5",
"uri": "sample string 6",
"loginStatus": "sample string 7",
"sendActivationEmail": "sample string 8",
"activationAccessCode": "sample string 9",
"errorDetails": {
"errorCode": "sample string 1",
"message": "sample string 2"
}
}
],
"previousUri": "sample string 1",
"nextUri": "sample string 2",
"startPosition": "sample string 3",
"endPosition": "sample string 4",
"resultSetSize": "sample string 5",
"totalSetSize": "sample string 6"
}
<powerFormSendersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
<endPosition>sample string 4</endPosition>
<nextUri>sample string 2</nextUri>
<powerFormSenders>
<userInfo>
<activationAccessCode>sample string 9</activationAccessCode>
<email>sample string 3</email>
<errorDetails>
<errorCode>sample string 1</errorCode>
<message>sample string 2</message>
</errorDetails>
<loginStatus>sample string 7</loginStatus>
<sendActivationEmail>sample string 8</sendActivationEmail>
<uri>sample string 6</uri>
<userId>sample string 2</userId>
<userName>sample string 1</userName>
<userStatus>sample string 5</userStatus>
<userType>sample string 4</userType>
</userInfo>
</powerFormSenders>
<previousUri>sample string 1</previousUri>
<resultSetSize>sample string 5</resultSetSize>
<startPosition>sample string 3</startPosition>
<totalSetSize>sample string 6</totalSetSize>
</powerFormSendersResponse>