List

Get a list of workflows from the user’s organization with pagination.

Request

POST https://api.cloudplan.biz/api/workflow/list
{
    "limit": 3,             //(optional) amount of elements
    "page": 1,              //(optional) number of the page
    "search": "...",        //(optional) string to search by workflow's name
    "status": "..."         //(optional) filter by workflow's status. Values: "template", "draft", "running", "finished"
    "docclass_ids": [".."]  //(optional, list of strings) return workflows that have at least one of these docclass ids
    "offline_available":true//(optional, boolean) offline available template search
}

Reply

{
    "status": 200,
    "result": true,
    "params": [],
    "data": {
        "workflows": [
            {
                "project_name": "qqq",
                "project_description": "sdfgdsfg",
                "project_deadline": 1583484780,
                "project_message_signer": "dfgdfgdfgsdfg",
                "project_runtime": "",
                "project_remind_freq": 86400,
                "cp_id": "5E58D529AC4CCEFC31E8AAC9E32BCD46",
                "project_type": "contract",
                "created": 1582880041,
                "status": "draft",
                "creator_cp_id": "56A23E83C9A4AA62AAE4DC6055F7893B",
                "start_time": "",
                "starter_cp_id": "",
                "starter_email": "",
                "target_folder_cp_id": "5E58D529AC4CCEFC31E8AAC9E32BCH77",
                "signing_steps": [
                    [
                        {
                            "group_cp_id": "5F2BE9D8139E3C108775E690319D2E5B",
                            "token": "5F3D3C25A59952B168DDB5950C6CB4ED",
                            "name": "YO",
                            "rule": "must_sign"
                        }
                    ]
                ],
                "documents": [
                    {
                        "file_cp_id": "VGVZDGZPBGUTMTQ5",
                        "file_name": "Testfile-149Loremipsumdolorsitametconsect.pdf",
                        "folder_cp_id": "5ECE77176D70DAF6EFA685DBDA719957",
                        "file_options": []
                    },
                    {
                        "file_cp_id": "5F1AB1FD371382D05B88FD3FB0BBBA9D",
                        "file_name": "File-1",
                        "folder_cp_id": "plain",
                        "file_options": []
                    }
                ]
            },
            {
                "project_name": "fgdfgsdfgsdfg",
                "project_description": "dfgsdfgdsfg",
                "project_deadline": 1582632900,
                "project_message_signer": "dfgfdgdsfg",
                "project_runtime": "",
                "project_remind_freq": 86400,
                "cp_id": "5E4BD766895E5D582EB62C9203AAF366",
                "project_type": "contract",
                "created": 1582028646,
                "status": "draft",
                "creator_cp_id": "56A23E83C9A4AA62AAE4DC6055F7893B",
                "start_time": "",
                "starter_cp_id": "",
                "starter_email": "",
                "target_folder_cp_id": "5E58D529AC4CCEFC31E8AAC9E32BCH77",
                "signing_steps": [
                    [
                        {
                            "group_cp_id": "5F2BE9D8139E3C108775E690319D2E5B",
                            "token": "5F3D3C25A59952B168DDB5950C6CB4ED",
                            "name": "YO",
                            "rule": "must_sign"
                        }
                    ]
                ],
                "documents": [
                    {
                        "file_cp_id": "VGVZDGZPBGUTMTQ5",
                        "file_name": "Testfile-149Loremipsumdolorsitametconsect.pdf",
                        "folder_cp_id": "5ECE77176D70DAF6EFA685DBDA719957",
                        "file_options": []
                    },
                    {
                        "file_cp_id": "5F1AB1FD371382D05B88FD3FB0BBBA9D",
                        "file_name": "File-1",
                        "folder_cp_id": "plain",
                        "file_options": []
                    }
                ]
            },
            {
                "project_name": "Testprojekt 1",
                "project_description": "",
                "project_deadline": 1582306800,
                "project_message_signer": "Bitte Unterschreiben",
                "project_runtime": "",
                "project_remind_freq": 86400,
                "cp_id": "5E46DBB3D688D2C01111FF54FEED92AD",
                "project_type": "contract",
                "created": 1581702067,
                "status": "finished",
                "creator_cp_id": "56A23B5444D384B805785604C517C14B",
                "start_time": "",
                "starter_cp_id": "56A23B5444D384B805785604C517C14B",
                "starter_email": "",
                "target_folder_cp_id": "5E58D529AC4CCEFC31E8AAC9E32BCH77",
                "signing_steps": [
                    [
                        {
                            "group_cp_id": "5F2BE9D8139E3C108775E690319D2E5B",
                            "token": "5F3D3C25A59952B168DDB5950C6CB4ED",
                            "name": "YO",
                            "rule": "must_sign"
                        }
                    ]
                ],
                "documents": [
                    {
                        "file_cp_id": "VGVZDGZPBGUTMTQ5",
                        "file_name": "Testfile-149Loremipsumdolorsitametconsect.pdf",
                        "folder_cp_id": "5ECE77176D70DAF6EFA685DBDA719957",
                        "file_options": []
                    },
                    {
                        "file_cp_id": "5F1AB1FD371382D05B88FD3FB0BBBA9D",
                        "file_name": "File-1",
                        "folder_cp_id": "plain",
                        "file_options": []
                    }
                ]
            }
        ],
        "meta": {
            "limit": 3,
            "page": 1,
            "total": 389
        }
    }
}