Skip to Content
Birthdays & Milestones

Get aggregate birthday statistics

View Markdown (.md)
GET
/api/v1/public/birthdays/stats

Returns upcoming birthday counts for the current week and month, and active celebration template status.

Authorization

headerX-Api-Key<token>

SMS Pro API Key (sk_live_... or sk_test_...)

Response Body

Birthday counts and active automation status

application/json
  1. response
status?string
data?
Example Request
curl -X GET 'https://api.smspro.com/api/v1/public/birthdays/stats'
Example Response
{  "status": "string",  "data": {    "thisWeek": 0,    "thisMonth": 0,    "automationActive": true  }}