Cflow

Add a comment to a record.

add_comment

Get completed requests for a workflow within a date range. Cflow restricts this; not every account can use it.

report_completed_requests

Create a new role. Cflow restricts this; not every account can use it.

create_role

Create a new team. Cflow restricts this; not every account can use it.

create_team

Get the current status breakdown of a workflow within a date range. Cflow restricts this; not every account can use it.

report_current_status

Get/Download a file or signature attached to a record's field, returned as base64.

get_record_file

Enable a disabled user by username. Cflow restricts this; not every account can use it.

enable_user

Get records updated/reviewed within a date range. This covers ALL users and carries no stage field, so it cannot tell completed records from in-flight ones. The whole date range is covered in one go, so there is no need to ask for it in slices. Results are limited to records reviewed by the signed-in user unless reviewedBy names another user or 'all'. Cflow restricts that; not every account can use it. Note that the record's submitter and its reviewer are different people; this filters on the reviewer.

list_reviewed_records

Get the list of all roles defined in Cflow. Cflow restricts this; not every account can use it.

list_roles

Get records submitted within a date range, ordered by the given date field. This covers ALL users and carries no stage field, so it cannot tell completed records from in-flight ones. The whole date range is covered in one go, so there is no need to ask for it in slices. Results are limited to the signed-in user's records unless initiatedBy names another user or 'all'. Cflow restricts that; not every account can use it.

list_initiated_records

Get the list of all teams. Cflow restricts this; not every account can use it.

list_teams

Get the list of all users. Cflow restricts this; not every account can use it.

list_users

Get all workflows visible to the caller.

list_workflows

Get pending request details for a workflow within a date range, for any user in the account. For the signed-in user's own pending work use get_pending_items instead — every role can call it. Never guess a username from an email address or a display name. Cflow restricts this; not every account can use it.

report_pending_requests

Remove a role from a user. Cflow restricts this; not every account can use it.

remove_role

Get SLA report details for a workflow and one or more stages within a date range. Use 'all' for stageNames unless you specifically want a subset — hand-listing stages is how the terminal stage (where completed requests sit) gets left out. Cflow restricts this; not every account can use it.

report_sla

Search for records in a workflow/lookup stage. Narrow it with extra search criteria: field name/value pairs joined with '&', e.g. 'Name=john&Age=22'.

search_record

Get stage performance details for a workflow within a date range. Cflow restricts this; not every account can use it.

report_stage_performance

Get stage visit details for a workflow within a date range. Cflow restricts this; not every account can use it.

report_stage_visits

Create and submit a new record into a workflow/lookup stage. Call get_fields first to discover valid field names for valuesJson/tableValuesJson.

submit_record

Update a record's details and status (e.g. approve/reject), including deleting table rows via TableDelRowIds.

update_record

Update an existing team's name and/or membership. Cflow restricts this; not every account can use it.

update_team

Update an existing user's details. Cflow restricts this; not every account can use it.

update_user

Update the access permission configuration (role, view scope, edit scope) for one workflow stage. Value should be 'All Items', 'My Items', or 'My Team' (editAccess may also be 'None'). Cflow restricts this; not every account can use it.

update_access_permission

Get full details of a record by workflow/lookup id.

get_record_details

Get the current stage and status of a record.

get_current_stage

Get details of a single user by username. Cflow restricts this; not every account can use it.

get_user

Get the roles assigned to a user by username. Cflow restricts this; not every account can use it.

get_user_roles

Get all field details (section fields and tables) for a workflow/lookup stage. Call this before submit_record or update_record to discover valid field names.

get_fields

Get all comments on a record.

get_comments

Get pending items. Omit username for the signed-in user's own items — that is the usual case, and what to do whenever someone asks about 'my' pending items. Pass a username only to look at someone else's, which Cflow restricts. Never guess a username from an email address or a display name.

get_pending_items

Get the access permission details (role, view scope, edit scope) for every stage of a workflow. Cflow restricts this; not every account can use it.

get_access_permissions

Get the members of a team by team id. Cflow restricts this; not every account can use it.

get_team_members

Get all stages of a workflow, in flow order, with its terminal stage named in 'terminalStage'. That is the stage a request reaches when it has finished the flow, so it is the one that means completed/closed/done — read it from here rather than guessing, because it is 'END' in some workflows and something like 'End & Final/Requests' in others.

get_workflow_stages

Get workflow(s) triggered by the given record.

get_triggers

Get workflow cycle-time performance details within a date range. Cflow restricts this; not every account can use it.

report_workflow_performance