Get Birthdays
get_birthdaysWhose birthday is coming up or was just missed: the user's contacts with a birthday in a window (days_back before and days_ahead after today, 30 each, or from/to), in the account timezone. upcoming (days_until) and recent (days_since), soonest first then closest: birthday_on, age_turning (null when the year is unknown), birthday_precision, relationship, tier, is_favorite, last_in_touch, in_touch_since_birthday. Counts contacts without a birthday. Excludes Me, never-share and deceased contacts (include_deceased adds them as remembrance). ($0.05; API key required)
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_birthdays"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Window end YYYY-MM-DD (instead of days_ahead). At most 366 days in all. | |
| from | No | Window start YYYY-MM-DD (instead of days_back). | |
| limit | No | Per list (default 25). | |
| days_back | No | Days before today, for missed birthdays (default 30). | |
| days_ahead | No | Days after today (default 30). | |
| include_deceased | No | Add deceased contacts, marked remembrance (default false). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | ||
| count | Yes | ||
| today | No | Today in the account timezone (YYYY-MM-DD). | |
| recent | No | ||
| window | No | { from, to }: the inclusive civil window. | |
| account | No | The Dayze account this data belongs to. With more than one Dayze connection, name it in the answer. | |
| timezone | No | ||
| upcoming | No | ||
| truncated | No | ||
| without_day | No | { count, hint }: contacts with only a birth year or year and month. | |
| inspect_note | No | How to cite: link each record with its inspect_url, never a link built from an id; which record types here have no Dayze page. | |
| recent_count | No | ||
| upcoming_count | No | ||
| remembrance_note | No | ||
| missing_birthdays | No | { count, hint }: contacts without a birthday in Dayze. |