Skip to main content
Permission: Read · Workspace: required (from goody_workspaces_list) Lists the active contact lists in a workspace, newest first. Use it before goody_autogift_rules_create so the user can pick a recipient list.

​
Parameters

​
workspace_id
string
required
Workspace UUID — from goody_workspaces_list. Lists are scoped to this workspace.
​
page
integer
default:"1"
Page number, 1-indexed.
​
per_page
integer
default:"25"
Lists per page. Maximum 100.

​
Returns

​
contact_lists
object[]
The active contact lists, newest first.
​
page
integer
The page returned.
​
per_page
integer
Lists per page.
​
total_count
integer
Total active lists in the workspace.

​
Example

"What contact lists do I have?"

{
  "name": "goody_contact_lists_list",
  "arguments": { "workspace_id": "3f8a…" }
}

{
  "contact_lists": [
    { "id": "c1e9…", "name": "Q3 onboarding cohort", "kind": "User-added", "contact_count": 12 },
    { "id": "b730…", "name": "Engineering", "kind": "HRIS-synced", "contact_count": 48 }
  ],
  "page": 1,
  "per_page": 25,
  "total_count": 2
}
No list yet? Build one with goody_contact_lists_create, then point an goody_autogift_rules_create rule at it.