Skip to main content
Permission: Read · Workspace: required (from goody_workspaces_list) Lists the autogift (recurring gift) rules in a workspace — the rules that send a gift automatically when a recipient hits a birthday, work anniversary, or onboarding milestone.

​
Parameters

​
workspace_id
string
required
Workspace UUID — from goody_workspaces_list. Rules in this workspace are returned.
​
status
string
Filter by rule state — one of active, paused, or inactive. Omit to return rules in all states.
​
page
integer
default:"1"
Page number, starting at 1.
​
per_page
integer
default:"25"
Results per page. Maximum 100.

​
Returns

​
autogift_rules
object[]
The matching autogift rules.
​
page
integer
The current page number.
​
per_page
integer
Results per page.
​
total_count
integer
Total number of matching rules across all pages.

​
Example

"What autogifts do I have running?"

{
  "name": "goody_autogift_rules_list",
  "arguments": { "workspace_id": "3f8a…", "status": "active" }
}

{
  "autogift_rules": [
    {
      "id": "6d2a…",
      "status": "active",
      "event_type": "birthday",
      "contact_list": { "id": "d052…", "name": "Clients" },
      "card_id": "a7f9…",
      "from_name": "Jordan at Acme",
      "message": "Happy birthday, {{firstname}}!",
      "tenure_min": null,
      "tenure_max": null,
      "created_at": "2026-05-02T14:11:00Z"
    }
  ],
  "page": 1,
  "per_page": 25,
  "total_count": 1
}
Use a returned id with goody_autogift_rules_activate to turn a rule on, or goody_autogift_rules_pause to stop further sends.
To turn a listed rule on or off, use goody_autogift_rules_activate and goody_autogift_rules_pause.