Skip to main content
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.
integer
Total number of batches across all pages.

Example

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