Retrieve a quick workflow

Show a quick workflow if you want to see the current state of the actions, steps or workflow.

Tip

This is optional, when using the WorkflowNotificationCallbackUrlPreference you are automatically notified about workflow evolution.

Method	Path
GET	/api/v1/quick/envelopes/{id}

Example

curl --request GET 'https://app.yumisign.com/api/v1/quick/envelopes/20211123aba6531f586827ef412d5f9e729f572e' \
    --header 'Content-Type: application/json'

{
    "id": "20211123aba6531f586827ef412d5f9e729f572e",
    "name": "My project",
    "type": "simple",
    "status": "started",
    "createDate": 1631867777,
    "expiryDate": 1632472568,
    "startDate": 1631868479,
    "envelopeId": "20211123aba6531f586827ef412d5f9e729f572e",
    "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"
            }
        }
    ]
    "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
                }
            ]
        }
    ]
    "metadata": []
}