/bff/workflow/group-list

Returns all order groups for the organisation with related data: order count, status count, and the list of workflow statuses linked to each group via the N:M shop__order_group_status table. Always invokes the bootstrap function first — guarantees that the organisation has the default order group and the default workflow status set, and that the default group has all statuses linked.

WorkflowgetBffWorkflowGroup-list

No parameters

This endpoint takes no path, query, header or body parameters.

Request

GET /bff/workflow/group-list

get

curl -X GET "https://api.bizkithub.com/bff/workflow/group-list" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "items": [
    {
      "id": 0,
      "code": "default",
      "name": "example_name",
      "default": false,
      "active": false,
      "position": 0,
      "dueDateRelativeTime": "7d",
      "forceInvoice": false,
      "insertedDate": "example_insertedDate",
      "orderCount": 0,
      "statusCount": 0,
      "statuses": [
        {
          "id": 0,
          "code": "paid",
          "label": "example_label",
          "color": "#3c78d8",
          "workflowPosition": 0,
          "position": 0
        }
      ],
      "paymentGatewayPreference": {}
    }
  ],
  "itemCount": 0
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key