SUsurense
Customers

Search customers having upcoming birthdays

Search for customers who have birthdays in the next 30 days (from tomorrow to 30 days from today). Returns a paginated list of customers with their birthday information.

post/customers/birthdays/next

Request

  • Base URL
    https://api.surense.com/api/v1
  • URL
    https://api.surense.com/api/v1/customers/birthdays/next
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.surense.com/oauth/token scopes: customers:read

Request body

pageinteger

Page number for pagination

pageSizeinteger

Number of items per page

activeOnlyboolean

Filter to show only active customers

Example request

{
  "page": 1,
  "pageSize": 20,
  "activeOnly": true
}

Response

OK

hasNextPageboolean
totalElementsinteger

Changes

No recorded changes to this operation across all 1 revision of this API.