> ## Documentation Index
> Fetch the complete documentation index at: https://developer.ongoody.com/llms.txt
> Use this file to discover all available pages before exploring further.

# goody_autogift_rules_list

> List the autogift (recurring gift) rules in a workspace.

**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

<ParamField body="workspace_id" type="string" required>
  Workspace UUID — from `goody_workspaces_list`. Rules in this workspace are returned.
</ParamField>

<ParamField body="status" type="string">
  Filter by rule state — one of `active`, `paused`, or `inactive`. Omit to return rules in all states.
</ParamField>

<ParamField body="page" type="integer" default="1">
  Page number, starting at 1.
</ParamField>

<ParamField body="per_page" type="integer" default="25">
  Results per page. Maximum 100.
</ParamField>

## Returns

<ResponseField name="autogift_rules" type="object[]">
  The matching autogift rules.

  <Expandable title="autogift_rule">
    <ResponseField name="id" type="string">Rule UUID — pass to [`goody_autogift_rules_activate`](/mcp-reference/tools/autogift-rules-activate) or [`goody_autogift_rules_pause`](/mcp-reference/tools/autogift-rules-pause).</ResponseField>
    <ResponseField name="status" type="string">Rule state — `active`, `paused`, or `inactive`.</ResponseField>
    <ResponseField name="event_type" type="string">The occasion that triggers a send — e.g. `birthday`, `work_anniversary`, or `onboarding`.</ResponseField>

    <ResponseField name="contact_list" type="object">
      The contact list the rule watches.

      <Expandable title="contact_list">
        <ResponseField name="id" type="string">Contact list UUID.</ResponseField>
        <ResponseField name="name" type="string">The list's visible name.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="card_id" type="string | null">The greeting card chosen for the rule.</ResponseField>
    <ResponseField name="from_name" type="string | null">The "From" name recipients see.</ResponseField>
    <ResponseField name="message" type="string | null">The gift-card message template.</ResponseField>
    <ResponseField name="tenure_min" type="integer | null">Lowest years of service the rule applies to.</ResponseField>
    <ResponseField name="tenure_max" type="integer | null">Highest years of service the rule applies to.</ResponseField>
    <ResponseField name="created_at" type="string">When the rule was created.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="page" type="integer">The current page number.</ResponseField>
<ResponseField name="per_page" type="integer">Results per page.</ResponseField>
<ResponseField name="total_count" type="integer">Total number of matching rules across all pages.</ResponseField>

## Example

<CodeGroup>
  ```text 💬 Prompt theme={null}
  "What autogifts do I have running?"
  ```

  ```json 🔧 Tool call theme={null}
  {
    "name": "goody_autogift_rules_list",
    "arguments": { "workspace_id": "3f8a…", "status": "active" }
  }
  ```

  ```json ↩️ Result theme={null}
  {
    "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
  }
  ```
</CodeGroup>

<Note>
  Use a returned `id` with [`goody_autogift_rules_activate`](/mcp-reference/tools/autogift-rules-activate) to turn a rule on, or [`goody_autogift_rules_pause`](/mcp-reference/tools/autogift-rules-pause) to stop further sends.
</Note>

<Tip>
  To turn a listed rule on or off, use [`goody_autogift_rules_activate`](/mcp-reference/tools/autogift-rules-activate) and [`goody_autogift_rules_pause`](/mcp-reference/tools/autogift-rules-pause).
</Tip>
