Load a workflow board

GET

https://ssuccessv2.com/app/api/v1/workflow

Returns the active school's workflow template and selected module instances for the requested module.

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

modulestringRequired<=100 characters

Workflow module system name used to select the board.

module_idsstring or list of integersOptional

Optional comma-separated or repeated module identifiers used to limit instances.

Workflow template and module instances returned.

statusstringOptional

messagestringOptional

dataobjectOptional

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

1	{
2	"status": "success",
3	"message": "",
4	"data": {
5	"template": {
6	"id": 12,
7	"name": "Admissions",
8	"module_sysname": "form_submission",
9	"form_identifier_key": "admission",
10	"stages": [
11	{
12	"id": 31,
13	"name": "New",
14	"color": "#3B82F6",
15	"sort_order": 1,
16	"required_checks": []
17	}
18	]
19	},
20	"instances": [
21	{
22	"module_id": 101,
23	"instance_id": 501,
24	"current_stage_id": 31
25	}
26	]
27	}
28	}

$	curl -G https://ssuccessv2.com/app/api/v1/workflow \
>	-H "Authorization: Bearer <token>" \
>	-d module=form_submission