Get Workflow Users - SigningHub-APIGuide

Business applications can use this service API to get a list of users in the workflow.

https://api.signinghub.com/v3/packages/{package_id}/workflow/users
HTTP Verb		GET
Accept		application/json
Authorization		Bearer {access_token}
Request Body
Status Code	Message	Response Body
200	OK	`[` `{` `"order": 1,` `"user_email":` `"tom@ascertia.com",` `"user_name":` `"Tom",` `"group_name":` `"",` `"group_members": [` `{` `"user_email":` `"tom@ascertia.com",` `"user_name":` `"Tom"` `}` `],` `"delegatee":` `"clark@ascertia.com",` `"delegatee_name":` `"clark",` `"role":` `"SIGNER",` `"process_status":` `"PROCESSED",` `"processed_on":` `"2012-04-23T18:25:43.511Z",` `"processed_as":` `"COLLABORATOR",` `"processed_by":` `"abc@xyz.com",` `"reason":` `"",` `"placeholder":` `"",` `"signing_order": 1,` `"user_national_id":` `"tom-35202-2123472-8"` `}` ]
401	Unauthorized	`{` `"Message":` `"Request authorization denied"` `}`
		`{` `"Message":` `"User authentication required"` `}`
403	Forbidden	`{` `"Message":` `"Document does not belong to user"` `}`
		`{` `"Message":` `"Account is disabled"` `}`
404	Not Found	`{` `"Message":` `"Document not found"` `}`
500	Internal Server Error	`{` `"Message":` `"An internal server error occurred while processing the request"` `}`

The detail of each item provided in the request and response is provided below:

Item Details
Names	Description
Request Parameters
access_token	The access token obtained as a result of successful authentication. If "scope" parameter was used in authentication request, then this service requires the access token to be obtained using the credentials of an Enterprise admin whose enterprise role has the application integration privileges.
package_id	The ID of the document for which the recipients are to be requested.
Response Parameters
order	Order of the recipient in the workflow.
user_name	Name of the recipient if user is not a group.
user_email	Email address of the recipient if user is not a group.
group_name	Group name of the recipient if recipient is a group.
group_members	A list of email addresses of the group members if recipient is a group.
delegatee	Delegatee email address, if recipient is not a group.
delegatee_name	Name of the delegatee user, if recipient is not a group.
role	Workflow role in which the recipient was added. This role is not the enterprise role. Possible values are "SIGNER", "REVIEWER","CARBON_COPY" and "EDITOR".
process_status	Document processing status for the recipient. Possible values are "IN_PROGRESS", "SIGNED", "REVIEWED", "DECLINED", "EDITED" or "INVALID".
processed_on	Date and time on which the document was processed.
processed_as	User may processed the field as COLLABORATOR , DELEGATOR, GROUP_MEMBER or OWNER.
processed_by	Email address of the user who processed the document.
reason	Reason provided by the user when declining, approving or submitting a document.
placeholder	Placeholder text if the recipient is a placeholder
signing_order	Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".
user_national_id	National identity number of the user. This helps to identify user in the workflow
Message	The service specific error message returned by the API. This message provides useful information about why the service has returned an error response.