BizKitHub
DocsAPI ReferenceWorkflow/bff/workflow/group-list
getWorkflowAdmin BFF

/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

Parameters

No parameters required

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

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idnumberRequired

Internal numeric group ID.

codestringRequired

Stable group code (slug, unique per organisation).

Exampledefault
namestringRequired

Display name.

descriptionstring | nullRequired
One of 2:
Variant 1
string

Free-form admin description.

Variant 2
null
defaultbooleanRequired

Whether this group is the organisation default.

activebooleanRequired

Whether new orders can be assigned to this group.

positionnumberRequired

Sort order within the organisation.

dueDateRelativeTimestringRequired

Default due-date offset for new orders, e.g. "7d".

Example7d
invoicePrefixstring | nullRequired
One of 2:
Variant 1
string

Optional invoice number prefix (1–3 chars).

ExampleA
Variant 2
null
invoiceIssuerIdnumber | nullRequired
One of 2:
Variant 1
number

Contact ID of the invoice issuer override, or null to use the org default.

Variant 2
null
invoiceIssuerobject | nullRequired
One of 2:
Variant 1

Override contact who issues invoices for this group. null means the organisation's internal contact is used (default behaviour).

cuRefNostringRequired

shop__contact.external_id (16-char) — admin-facing contact reference.

namestringRequired

Display label. Company name with personal name in parens when both exist, otherwise whichever is set, otherwise email.

companyNamestring | nullRequired
One of 2:
Variant 1
string

Trading / legal name of the company, if set on the contact.

Variant 2
null
personalNamestring | nullRequired
One of 2:
Variant 1
string

Trimmed first last of the contact, or null when neither is set.

Variant 2
null
emailstring | nullRequired
One of 2:
Variant 1
string

Invoice issuer e-mail. null for phone-only contacts; in that case the issuer block on the invoice falls back to name and cuRefNo.

Variant 2
null
Variant 2
null
forceInvoicebooleanRequired

When true, paid orders in this group always get a full tax invoice regardless of country/threshold rules. The status-level create_receipt flag is suppressed for orders in this group — a single receipt cannot substitute for the required invoice on internal-party billing (e.g. franchise settlement).

useSystemDefaultNotificationsbooleanRequired

When true, sendOrderStatusNotification bypasses any per-group binding and per-org template variant configured for this organisation and sends the platform-baked default template keyed by the 4 status types (new / processing / storno / done). Used when the group hosts a flow (consulting, real-estate handoff, e-shop upsell inside a reservation-focused org) that does not fit the org's regular custom-template copy.

preferBankTransferPaymentbooleanRequired

When true, the system-default "order received" e-mail template renders bank transfer instructions (IBAN + variable symbol + payment QR) instead of the "Zaplatit online" button — provided the organisation has a bank account configured for the order currency and the order carries a variable symbol. Card payments through configured gateways continue to work; the flag only shapes the confirmation e-mail. Defaults to false.

notifyOnlyGroupTemplatesbooleanRequired

When true, only the templates assigned to this group per status are sent. A status without an assigned template sends no customer e-mail instead of falling back to the organisation-wide order-status template. Ignored when useSystemDefaultNotifications is on.

insertedDatestringRequired

ISO timestamp when the group was created.

orderCountnumberRequired

Total number of orders ever assigned to this group.

statusCountnumberRequired

Number of workflow statuses linked via shop__order_group_status.

statusesobject[]Required

Statuses enabled for this group, ordered by their group position then global workflow position.

Each array item:
idnumberRequired

Status internal ID.

codestringRequired

Status code.

Examplepaid
labelstringRequired

Status display label.

colorstringRequired

Hex color including leading #.

Example#3c78d8
workflowPositionnumberRequired

Global workflow position within the organisation.

positionnumberRequired

Position of the status within this group.

paymentGatewayPreferenceobjectRequired

How online payments resolve for orders in this group.

mode"fallback" | "specific" | "none"Required

"fallback" — group has no specific preference, resolver uses the org-wide active gateway. "specific" — group is bound to a single gateway instance (see gatewayCode). "none" — online payments are explicitly disabled for this group; no redirect, no fallback.

gatewayCodestring | nullRequired
One of 2:
Variant 1
string

Gateway instance code when mode is "specific".

Variant 2
null
gatewayInstanceIdnumber | nullRequired
One of 2:
Variant 1
number

Gateway instance internal ID when mode is "specific".

Variant 2
null
itemCountnumberRequired

Total number of groups returned.

Response example

application/json
{
  "items": [
    {
      "id": 0,
      "code": "default",
      "name": "example_name",
      "default": false,
      "active": false,
      "position": 0,
      "dueDateRelativeTime": "7d",
      "forceInvoice": false,
      "useSystemDefaultNotifications": false,
      "preferBankTransferPayment": false,
      "notifyOnlyGroupTemplates": 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
}

Request example

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"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key