contacts_list_birthdays
List iCloud contacts whose birthdays fall within the next N days, sorted soonest first, with dates, days until, and age they turn for planning greetings or reminders.
Instructions
List the owner's contacts whose birthday falls within the next N days, soonest first, with the date, days until it and the age they turn.
Use when: the owner asks whose birthday is coming up, or you are planning greetings or reminders. Not for one person's birthday (use contacts_get_contact) or for finding someone by name (use contacts_search_contacts). Parameters:
days: a whole number of days ahead; omitted means 30.
Values outside 1-366 are clamped, not refused (0 or negative becomes 1, above 366 becomes 366); the result's days field shows the value used.
Today (the server's local date) is day 0 and always included, so days=1 covers today and tomorrow; 366 covers a full year. Behavior:
read-only; nothing is sent or scheduled.
Only contacts with a saved birthday appear; group cards never do.
A 29 February birthday is listed on 28 February in non-leap years. Returns:
{from (today), days, count, birthdays, notice}.
Each entry is {name, uid, date (YYYY-MM-DD of the next occurrence), days_until, has_email}, plus turns (the new age) only when the birth year is known; use the uid with contacts_get_contact for details.
Sorted by days_until, then name. count=0 with a note means nobody with a saved birthday falls in the window. Errors: a sign-in or connection failure raises an error; run icloud_check_health.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| days | No | How many days ahead to look (default 30, max 366). |