Get Workflow Details - SigningHub-APIGuide

Business applications can use this service API to get workflow details for the package.

https://api.signinghub.com/v3/packages/{package_id}/workflow
HTTP Verb		GET
Authorization		Bearer {access_token}
Content-Type		application/json
Accept		application/json
Response Headers
Request Body
Status Code	Message	Response Body
200	OK	`{` `"package_id": 123,` `"package_name":` `"sales contract 105",` `"package_owner":` `"john@ascertia.com",` `"owner_name":` `"John Smith",` `"package_status":` `"PENDING",` `"folder":` `"INBOX",` `"unread":` `true,` `"next_signer":` `"Sam Crook",` `"next_signer_email": [` `{` `"user_email":` `"sam@ascertia.com",` `"user_name":` `"Sam Crook"` `}` `],` `"uploaded_on":` `"2015-01-12T11:12:13",` `"modified_on":` `"2015-01-13T10:10:25",` `"workflow": {` `"workflow_type":` `"SERIAL",` `"workflow_mode":` `"ME_AND_OTHERS",` `"continue_on_decline":` `false,` `"workflow_status":` `"COMPLETED",` `"read_only":` `true,` `"message":` `"",` `"post_process": {` `"enabled":` `true,` `"contacts": [` `"mike@ascertia.com",` `"rony@ascertia.com"` `],` `"recipients": [` `{` `"name":` `"John Miller",` `"email":` `"johnmiller@gmail.com"` `},` `{` `"name":` `"Sam",` `"email":` `"Sam_hoods@gmail.com"` `}` `],` `"workflow_recipients":` `true,` `"message":` `"",` `"google_drive":` `true,` `"dropbox":` `true` `}` `},` `"documents": [` `{` `"document_id": 123,` `"document_name":` `"sales contract 105",` `"document_order": 1,` `"document_type":` `"PDF",` `"document_source":` `"My App",` `"document_width": 600,` `"document_height": 800,` `"document_pages": 12,` `"uploaded_on":` `"2015-01-12T11:12:13",` `"modified_on":` `"2015-01-13T10:10:15",` `"form_fields":` `true,` `"lock_form_fields":` `true,` `"template": {` `"template_id": 123,` `"template_name":` `"Sales Contract Template",` `"read_only":` `true` `},` `"certify": {` `"enabled":` `true,` `"permission":` `"FORM_FILLING_ALLOWED"` `}` `},` `{` `"document_id": 123,` `"document_name":` `"sales contract 105",` `"document_order": 1,` `"document_type":` `"PDF",` `"document_source":` `"My App",` `"document_width": 600,` `"document_height": 800,` `"document_pages": 12,` `"uploaded_on":` `"2015-01-12T11:12:13",` `"modified_on":` `"2015-01-13T10:10:15",` `"form_fields":` `true,` `"lock_form_fields":` `true,` `"template": {` `"template_id": 123,` `"template_name":` `"Sales Contract Template",` `"read_only":` `true` `},` `"certify": {` `"enabled":` `true,` `"permission":` `"FORM_FILLING_ALLOWED"` `}` `}` `],` `"users": [` `{` `"order": 1,` `"user_email":` `"tom@ascertia.com",` `"user_name":` `"Tom",` `"group_name":` `"",` `"group_members": [],` `"delegator":` `"clark@ascertia.com",` `"role":` `"SIGNER",` `"process_status":` `"Signed",` `"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",` `"permission": {` `"print":` `true,` `"download":` `false,` `"add_text":` `true,` `"add_attachment":` `false,` `"change_recipients":` `true,` `"legal_notice": {` `"enabled":` `true,` `"allowed_notices": [` `{` `"legal_notice_name":` `"legal notice 1",` `"legal_notice_html":` `"<table>...<\/table>"` `},` `{` `"legal_notice_name":` `"legal notice 1",` `"legal_notice_html":` `"<table>...<\/table>"` `}` `],` `"default_notice": {` `"legal_notice_name":` `"legal notice 1",` `"legal_notice_html":` `"<table>...<\/table>"` `}` `}` `},` `"authentications": {` `"authentication": {` `"enabled":` `true,` `"password": {` `"enabled":` `true` `},` `"sms_otp": {` `"enabled":` `false,` `"otp_length": 8,` `"retry_duration": 30,` `"mobile_number":` `"00445566778899"` `}` `},` `"access_duration": {` `"enabled":` `true,` `"duration_by_date": {` `"enabled":` `true,` `"duration": {` `"start_date_time":` `"2015-02-13T12:10:000Z",` `"end_date_time":` `"2015-02-28T12:10:000Z"` `}` `},` `"duration_by_days": {` `"enabled":` `false,` `"duration": {` `"total_days": 4` `}` `}` `}` `},` `"reminder": {` `"enabled":` `true,` `"remind_after": 3,` `"repeat": {` `"enabled":` `true,` `"keep_reminding_after": 1,` `"total_reminders": 3` `}` `}` `},` `{` `"order": 2,` `"user_email":` `"harry@abc.com",` `"user_name":` `"Harry",` `"group_name":` `"",` `"group_members": [],` `"delegator":` `"daniel@ascertia.com",` `"role":` `"REVIEWER",` `"process_status":` `"REVIEWED",` `"processed_on":` `"2012-04-23T18:25:43.511Z",` `"processed_as":` `"COLLABORATOR",` `"processed_by":` `"abc@xyz.com",` `"reason":` `"",` `"placeholder":` `"",` `"signing_order": 2,` `"user_national_id":` `"harry-2123472-1",` `"permission": {` `"print":` `true,` `"download":` `false,` `"add_text":` `true,` `"add_attachment":` `false,` `"change_recipients":` `true,` `"legal_notice": {` `"enabled":` `true,` `"allowed_notices": [` `{` `"legal_notice_name":` `"legal notice 1",` `"legal_notice_html":` `"<table>...<\/table>"` `},` `{` `"legal_notice_name":` `"legal notice 1",` `"legal_notice_html":` `"<table>...<\/table>"` `}` `],` `"default_notice": {` `"legal_notice_name":` `"legal notice 1",` `"legal_notice_html":` `"<table>...<\/table>"` `}` `}` `},` `"authentications": {` `"authentication": {` `"enabled":` `true,` `"password": {` `"enabled":` `true` `},` `"sms_otp": {` `"enabled":` `false,` `"otp_length": 8,` `"retry_duration": 30,` `"mobile_number":` `"00445566778899"` `}` `},` `"access_duration": {` `"enabled":` `true,` `"duration_by_date": {` `"enabled":` `true,` `"duration": {` `"start_date_time":` `"2015-02-13T12:10:000Z",` `"end_date_time":` `"2015-02-28T12:10:000Z"` `}` `},` `"duration_by_days": {` `"enabled":` `false,` `"duration": {` `"total_days": 4` `}` `}` `}` `},` `"reminder": {` `"enabled":` `true,` `"remind_after": 3,` `"repeat": {` `"enabled":` `true,` `"keep_reminding_after": 1,` `"total_reminders": 3` `}` `}` `}` `]` }
403	Forbidden	`{` `"Message":` `"Account is disabled"` `}`
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 package to be downloaded.
Response Parameters
package_id	Package ID of the document package.
package_name	Name of the document package.
package_owner	Email address of the document package owner.
owner_name	Name of the document package owner.
package_status	Document status for the current logged in user. Possible values are "DRAFT", "INPROGRESS", "PENDING", "DECLINED", "APPROVED", "UPDATED" or "COMPLETED".
folder	Name of the folder which contains the document package.
next_signer	The name of the next signer if the document is in shared state.
next_signer_email	An object containing next signers username and email address. In case of group signer it will have a list of email addresses of all the group members.
next_signer_email > user_email	Email address of the next signer.
next_signer_email > user_name	Name of the next signer.
uploaded_on	Date and time when the document was uploaded.
modified_on	Date and time when the document was last modified.
workflow	Workflow object with the workflow details.
workflow > workflow_type	Type of the workflow, there are four types of workflows supported in the application. Possible values are "SERIAL", "PARALLEL", "INDIVIDUAL" and "CUSTOM".
workflow> workflow_mode	Mode of the workflow, there are three types of workflow modes supported in application. Possible values are "ONLY_ME", "ME_AND_OTHERS" and "ONLY_OTHERS"
workflow > continue_on_decline	True, if workflow needs to be continued even after a recipient declines at his turn.
workflow > workflow_status	Processing status of the workflow, possible values are "DRAFT", "IN_PRGORESS" and "COMPLETED".
workflow > read_only	If any template applied on the documents in this workflow is read only or locked template then the workflow is read only. SigningHub will not allow the end users to make any changes to this workflow in draft state and this workflow is to be shared as it is.
workflow > message	Any custom string message that is to be sent to all the recipient of the workflow by the document owner.
workflow > post_process	Post process object with all the post process configurations.
workflow > post_process > enabled	True, if post processing is enabled for the package.
workflow > post_process > contacts	List of email addresses to which the email will be sent when the workflow is completed.
workflow > post_process > recipients	List of the name and email addresses to whom the emails are sent when the post processing is executed after the workflow completion.
workflow > post_process > workflow_recipients	True, if workflow completion report is to be sent to all recipients of the workflow when post processing is executed. Default value is false.
workflow > post_process > message	Any custom string message that is to be sent to the contacts when the workflow is completed.
workflow > post_process > google_drive	True, if google drive uploading is turned on for the package. Documents will be uploaded to google drive when the workflow is completed.
workflow > post_process > dropbox	True, if dropbox uploading is turned on for the package. Documents will be uploaded to google drive when the workflow is completed.
documents	List of documents that are uploaded in the package.
documents > document_id	ID of the document.
documents > document_name	Name of the document.
documents > document_order	Order of the document in the document package.
documents > document_type	Original document extension when the document was uploaded before conversion to the PDF.
documents > document_source	Source of the document from where the document was uploaded.
documents > document_width	Width of the PDF document.
documents > document_height	Height of the PDF document.
documents > document_pages	Total number of pages in the document.
documents > uploaded_on	The date and time on which the document was uploaded.
documents > modified_on	The date and time on which the document was last modified.
documents > form_fields	True, if document has form fields.
documents > lock_form_fields	True, if document is set to lock the form fields with the last digital signature on the document.
documents > template	Template object which is applied on the document along with the template details.
documents > template > template_id	ID of the template applied to the document.
documents > template > template_name	Name of the template applied to the document.
documents > template > read_only	True, if template is configured as read only. No changes to the workflow should be made after a read only template is applied.
documents > certify > enabled	True, if certify signature settings are enabled for the document.
documents > certify > permission	Certify permission level set for the document with certify signature settings.
users	Recipients list for the workflow.
users > order	Order of the recipient in the workflow.
users > user_email	Email address of the recipient if recipient is not a group or placeholder.
users > user_name	Name of the recipient if recipient is not a group. If recipient is a placeholder it will contain the name of the placeholder.
users > group_name	Name of the group if recipient is a group.
users > group_members	List of all the email addresses and names of the users.
users > delegator	Email address of the user who is delegator to this recipient.
users > role	Role of the recipient i.e., "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" or "INPERSON_HOST".
users > process_status	Document processing status for the recipient. Possible values are "UN_PROCESSED", "IN_PROGRESS", "SIGNED", "REVIEWED", "DECLINED", "EDITED" or "INVALID".
users > processed_on	Date and time on which the document was processed.
users > processed_as	User may processed the field as COLLABORATOR, DELEGATOR, GROUP_MEMBER or OWNER.
users > processed_by	Email address of the user who processed the document.
users > reason	Reason provided by the user when declining, approving or submitting a document.
users > placeholder	Placeholder text if the recipient is a placeholder.
users > 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".
users > user_national_id	National identity number of the user. This helps to identify user in the workflow
users > permission	Permissions for the recipient set by the owner of the document package.
users > permission > print	True, if recipient has the permission to print the document.
users > permission > download	True, if recipient has the permission to download the document.
users > permission > add_text	True, if the recipient has the permission to add text on the document.
users > permission > add_attachment	True, if the recipient has the permission to add attachments to the PDF document.
users > permission > change_recipients	True, if recipient has the permission to change other recipients after the document package is shared.
users > permission > legal_notice	Legal notice set by the owner for the recipient.
users > permission > legal_notice > enabled	True, if legal notice is enabled by the owner for the recipient.
users > permission > legal_notice > allowed_notices	List of allowed legal notices for the owner of the document to select from.
users > permission > legal_notice > allowed_notices > legal_notice_name	Name of the legal notice.
users > permission > legal_notice > allowed_notices > legal_notice_html	HTML content for the legal notice.
users > permission > legal_notice > default_notice	Default legal notice selected for the recipient if legal notice is enabled.
users > authentications	Authentications object with the details of any authentications and access securities configured for the recipient.
users > authentications > authentication	Authentication object with the details of authentication methods applied on the document for the recipient.
users > authentications > authentication > enabled	True, if authentication is enabled.
users > authentications > authentication > password	Password authentication object.
users > authentications > authentication > password > enabled	True, if password authentication is enabled.
users > authentications > authentication > sms_otp	SMS OTP authentication object.
users > authentications > authentication > sms_otp > enabled	True, if SMS OTP authentication is enabled.
users > authentications > authentication > sms_otp > mobile_number	A valid mobile number of the recipient on which the OTP (One Time Password) is to be sent.
users > authentications > access_duration	Access duration object with the details of access securities for the recipient.
users > authentications > access_duration > enabled	True, if access duration is enabled for the recipient.
users > authentications > access_duration > duration_by_date	Duration by date object with the details of duration in dates.
users > authentications > access_duration > duration_by_date > enabled	True, if duration by date is enabled for the recipient.
users > authentications > access_duration > duration_by_date > duration	Duration object with the details of duration in to and from dates.
users > authentications > access_duration > duration_by_date > duration > start_date_time	Date from where the access is allowed for the recipient.
users > authentications > access_duration > duration_by_date > duration > end_date_time	Date to which the access duration is allowed for the recipient.
users > authentications > access_duration > duration_by_days	Duration by days object with the details of duration.
users > authentications > access_duration > duration_by_days > enabled	True, if duration by days is enabled.
users > authentications > access_duration > duration_by_days > duration	Duration object with the details of total days.
users > authentications > access_duration > duration_by_days > duration > total_days	Total number of days for which the document is allowed to access, since recipient received the document.
users > reminder	Reminder object with the details of reminder settings.
users > reminder > enabled	True, if reminder is enabled for the recipient.
users > reminder > remind_after (days)	Number of days after which a reminder will be sent to the recipient. Days are calculated from the exact time of receiving the document.
users > reminder > repeat	Repeat object with the details of reminder being repeated or not.
users > reminder > repeat > enabled	True, if repeated reminders are to be sent.
users > reminder > repeat > keep_reminding_after (days)	Number of days after which the subsequent reminders are to be sent to the recipient.
users > reminder > repeat > total_reminders	Total number of repeated reminders.
Message	The service specific error message returned by the API. This message provides useful information about why the service has returned an error response.