The workflow object

Attributes

• id integer

The workflow identifier.

• envelopeId string

The envelope identifier.

• name string

The name of the workflow.

• type enum

The workflow type can be simple, advanced or qualified. It depends on the type of signature requested.

• status string

The workflow status can be not_started, started, approved, declined, canceled, expired, to_be_archived or signed.

• createDate integer

A timestamp of the creation date.

• expiryDate string

A timestamp of the expiration date.

• startDate string

A timestamp of the start date.

• documents array

An array of documents linked to the workflow.

• users array

An array of users linked to the workflow.

• recipients array

An array of recipients linked to the workflow.

• steps array

An array of steps linked to the workflow.

• fields array

An array of fields linked to the workflow.

Example

{
    "id": 1,
    "name": "My project",
    "type": "simple",
    "status": "started",
    "createDate": 1631867777,
    "expiryDate": 1632472568,
    "startDate": 1631868479,
    "envelopeId": "20211123aba6531f586827ef412d5f9e729f572e",
    "senderMessage": "Please sign this document",
    "documents": [
        {
            "id": 1,
            "position": 1,
            "file": {
                "name": "document.pdf"
                "format": "pdf",
                "size": 104421,
                "file": "https://app.yumisign.com/api/v1/storage/temp/1/doc/614453811441328b1fc832ce7ff2f371",
                "thumb": "https://app.yumisign.com/api/v1/storage/temp/1/doc/614453814f5160be65058abf90e5c30c"
            }
        }
    ],
    "users": [
        {
            "id": 1,
            "name": "John Doe",
            "role": "owner",
            "email": "john.doe@example.com"
        }
    ],
    "recipients":[
        {
            "id": 1,
            "name": "Jane Doe",
            "email": "jane.doe@example.com",
            "roles": [
                {
                    "id": 1,
                    "type": "sign",
                    "color":"#EE8320"
                }
            ]
        }
    ],
    "steps": [
        {
            "id": 1,
            "order": 1,
            "type": "sign",
            "status": "started",
            "expiryDate": null,
            "actions": [
                {
                    "id": 1,
                    "stepNumber": 1,
                    "role": 1,
                    "type": "sign",
                    "status": "started",
                    "recipientId": 1,
                    "recipientEmail": "jane.doe@example.com",
                    "comment": null
                }
            ]
        }
    ],
    "fields":[
        {
            "id": 1,
            "role": 1,
            "type": "signature",
            "label": "Signature",
            "documentId": 1,
            "page": 1,
            "value": null,
            "posY": 40.62,
            "posX": 34.96,
            "style":{
                "color": "#000000",
                "fontStyle": "Arial",
                "fontSize": 11,
                "width":2 9.92,
                "height": 10.57,
                "bold": false,
                "italic": false,
                "underline": false
            }
        }
    ],
    "metadata": []
}