Skip to main content
Permission: Read · Workspace: required (from goody_workspaces_list) Searches the contacts in a workspace and returns up to limit matches. Use it to find a recipient before pricing or sending a gift. Match a free-text query across name, email, and phone — or omit it to list everyone alphabetically.

Parameters

workspace_id
string
required
Workspace UUID — from goody_workspaces_list. Search is always scoped to this workspace.
query
string
Free-text search matched across first name, last name, email, and phone. Name matches outrank email matches, which outrank phone matches. Omit to list contacts alphabetically.
limit
integer
default:"25"
Maximum contacts to return. Range 1–25; higher values are clamped to 25. There’s no pagination — narrow query instead of raising the limit.

Returns

contacts
object[]
Up to limit matching contacts.
The search response omits event dates. To get a contact’s birthday or work anniversary, call goody_contacts_get.

Example

"Find my contact Sarah at Acme."
Once you have a match, call goody_contacts_get for the full detail (including birthday and work anniversary), or goody_contacts_update to edit it.