Get workflow board

GET

https://app.schoolset.io/app/api/v1/workflow

GET

/app/api/v1/workflow

1 curl https://app.schoolset.io/app/api/v1/workflow \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "status": "success",
3   "message": "Workflow board retrieved successfully.",
4   "data": {
5     "template": {
6       "id": 42,
7       "name": "Student Enrollment Process",
8       "module_sysname": "student_enrollment",
9       "form_identifier_key": "enrollment_form_id",
10       "stages": [
11         {
12           "id": 101,
13           "name": "Application Received",
14           "color": "#3498db",
15           "sort_order": 1,
16           "required_checks": [
17             {
18               "check_name": "Verify Application Completeness",
19               "mandatory": true
20             }
21           ]
22         },
23         {
24           "id": 102,
25           "name": "Interview Scheduled",
26           "color": "#f1c40f",
27           "sort_order": 2,
28           "required_checks": [
29             {
30               "check_name": "Confirm Interview Date",
31               "mandatory": true
32             }
33           ]
34         },
35         {
36           "id": 103,
37           "name": "Enrollment Confirmed",
38           "color": "#2ecc71",
39           "sort_order": 3,
40           "required_checks": [
41             {
42               "check_name": "Receive Enrollment Fee",
43               "mandatory": true
44             }
45           ]
46         }
47       ]
48     },
49     "instances": [
50       {
51         "module_id": 42,
52         "instance_id": 9876,
53         "current_stage_id": 102
54       },
55       {
56         "module_id": 42,
57         "instance_id": 9877,
58         "current_stage_id": 101
59       }
60     ]
61   }
62 }

Returns workflow boards for the selected module and module records.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Response

Successful GET response for /api/v1/workflow.

statusenum

Allowed values:

messagestring

dataobject