Starhunter icon

Starhunter

Interact with Starhunter

Actions12

Person → Get Birthdays

AI-generated

Summary

Retrieve a list of persons who have birthdays on a specified date, defaulting to today's date if not provided, with an optional limit on the number of results.

Inputs

  • Use Today's Date — Boolean flag to determine whether to use today's date for the birthday search. Defaults to true.
  • Date — The specific date to search for birthdays in MM-DD format, used only if 'Use Today's Date' is set to false.
  • Limit — Maximum number of birthday records to return, between 1 and 1000. Defaults to 50.

Output shape

a list of person objects, each containing fields such as id, name, firstName, secondName, middleName, academicTitle, salutation, email, birthDate, phone, functions, address, createdAt, and updatedAt.

If 'Use Today's Date' is true or unspecified, birthdays for the current date are retrieved; otherwise, the 'Date' field is used. The query may throw errors if the API response includes errors, returned as NodeApiError in n8n.

Links

Discussion