Specification Changes to the Approval Workflow List Endpoint (Approvalflow::list)
Published: 2026-11-11
In the January 2027 general release, the behavior of the approval workflow list endpoint (Approvalflow::list) will change. The impact and required actions depend on whether module_type is specified in the endpoint settings. Please check your endpoint settings and take the necessary actions before the release.
When module_type is not specified
Changes
- Only workflows that meet all of the following conditions will be returned. Currently, no filtering is applied, and disabled workflows are also returned.
- The calling member can apply for the workflow (the workflow's [Restriction] is set to [No selection], or the member belongs to a group selected in [Restriction])
- The workflow is enabled
- At least one approver is configured
- If the
cntquery parameter is omitted, all items will be returned instead of 20 items per page, andpageInfowill contain onlytotalCnt. In this case, thepageIDquery parameter is ignored even if specified. - The
per_pagequery parameter will no longer be available.
Required actions
- To keep retrieving all workflows as you do now, enable
ignore_apply_restrictionandignore_enable_flgin the endpoint settings. These two parameters were added in the October 2026 general release. Whenmodule_typeis not specified, setting them does not change the current behavior, so you can set them in advance. - Workflows with no approvers configured will no longer be returned, regardless of these two parameters.
- If you page through results with the
pageIDquery parameter, or if you use items ofpageInfoother thantotalCnt, specify 1 or more for thecntquery parameter. If you currently do not specifycnt, specifyingcnt=20keeps the current 20 items per page. Becausecntwas added in the October 2026 general release, you can specify it in advance. - If you specify the number of items with the
per_pagequery parameter, change it tocnt.
When module_type is specified
Changes
Permission check
Regardless of the endpoint settings, the endpoint will always check whether the calling member has the following permissions. You must call the endpoint while logged in (authenticated with a cookie, a dynamic access token, or a privileged static token) as a member who has these permissions. If you call the endpoint without logging in, or as a member without these permissions, a 403 error is returned. When called by a member with these permissions, the returned workflows will not change.
module_type | Required permission |
|---|---|
topics (with module_id) | The view permission for approval workflows, or the update permission for the content definition specified by module_id |
topics (without module_id) | Only the view permission for approval workflows (the update permission for content is not sufficient) |
inquiry / csvtable / tag | The view permission for approval workflows, or the update permission for the target module |
Currently, the list may be returned without checking these permissions.
pageInfo when cnt is omitted
If the cnt query parameter is omitted, pageInfo will contain only totalCnt. Currently, it contains totalCnt, perPage, totalPageCnt, and pageNo. All items are still returned.
Required actions
- If you call the endpoint without logging in, or as a member without these permissions, change it to call the endpoint while logged in as a member with these permissions. There is no setting to keep the current behavior.
- If you omit
cntand useperPage,totalPageCnt, orpageNoinpageInfo, change your code to usetotalCnt. Currently, whencntis omitted,perPagehas the same value astotalCnt, andtotalPageCntandpageNoare always1.
Rollout Timeline
These changes are planned to be reflected in the January 2027 general release.
Contact
If you have any further questions regarding this matter, please feel free to contact Kuroco Support.
Related documents
Support
If you have any other questions, please contact us or check out Our Slack Community.