Skip to main content

​
Summary

Fetch workspace birthdays organized by date. Filter by date and length.

​
Request

GET https://api.planetaryapp.us/v1/workspace/{workspace_id}/birthdays

​
Query Parameters

ParameterTypeDescription
referencedateISO 8601Filter by date (e.g., 2024-01-01T00:00:00Z)
filterDaystringAmount of days requested (e.g., 7)

​
Response example

{
  "success": true,
  "birthdays": [
    {
      "userId": 123456789,
      "username": "cloudysatrn",
      "birthdayDay": 15,
      "birthdayMonth": 12,
      "daysAway": 0,
      "nextBirthday": "2025-12-15"
    }
  ],
  "total": 1,
  "filterDays": 7,
  "referenceDate": "2025-12-07"
}