goody_order_batches_list

Permission: Read · Workspace: required (from goody_workspaces_list) Lists previously-sent gift batches in a workspace, most recent first. This is how you answer “what did I send recently?”.

Parameters

string

required

Workspace UUID — from goody_workspaces_list. Listing is always scoped to this workspace.

integer

default:"1"

Page number, starting at 1.

integer

default:"25"

Batches per page. Defaults to 25, max 100.

Returns

object[]

Batch summaries, most recent first. Each object also includes additional summary fields beyond those listed here.

Show order batch

string

Batch UUID — pass as order_batch_id to goody_order_batches_get or goody_orders_list.

string | null

The batch’s name.

string

Where the batch is in its lifecycle.

string | null

The “From” name recipients see.

string | null

The gift-card message.

string | null

card, balance, workspace_balance, corporate_account, or commerce_stored_value; null when unknown or for commerce app orders. For a batch, this describes the selected funding source, not a combined payment result for its orders.

string (uuid) | null

Goody card payment method UUID, including inactive cards. Null for account funding, commerce app orders, or when the card is unknown.

integer

Number of orders in the batch.

integer

Number of recipients.

string | null

When the batch is scheduled to send, if scheduled.

integer

Total number of batches across all pages.

Example

"Show me my last few gifts."

{
  "name": "goody_order_batches_list",
  "arguments": { "workspace_id": "3f8a…", "per_page": 3 }
}

{
  "order_batches": [
    {
      "id": "b92e…",
      "batch_name": "Q2 client thank-yous",
      "send_status": "sent",
      "from_name": "Jordan at Acme",
      "message": "Thank you for a great quarter, {{firstname}}!",
      "funding_source": "card",
      "payment_method_id": "79eec4e2-9022-4d4d-b9e1-81ca2807db2f",
      "orders_count": 12,
      "recipients_count": 12,
      "scheduled_send_on": null
    },
    {
      "id": "4a07…",
      "batch_name": "Welcome — new hires",
      "send_status": "scheduled",
      "from_name": "The Acme Team",
      "message": "Welcome aboard, {{firstname}}!",
      "funding_source": "workspace_balance",
      "payment_method_id": null,
      "orders_count": 3,
      "recipients_count": 3,
      "scheduled_send_on": "2026-07-01T09:00:00Z"
    }
  ],
  "total_count": 47
}

For the full detail of one batch use goody_order_batches_get; to list the individual orders inside a batch use goody_orders_list.

Reference

Account & workspaces

Discover gifts & cards

Contacts

Messages

Payment methods

Send & track gifts

Autogifts

Feedback

Parameters

Returns

Example