Skip to main content
GET
List giving-anniversary opportunities

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Query Parameters

status
enum<string> | null

Status. Validation: nullable; allowed values: all, upcoming, due, acted, snoozed, dismissed, missed.

Available options:
all,
upcoming,
due,
acted,
snoozed,
dismissed,
missed,
null
milestone_type
enum<string> | null

Milestone type. Validation: nullable; allowed values: first_gift, first_one_time_gift, first_recurring_gift, first_sponsorship.

Available options:
first_gift,
first_one_time_gift,
first_recurring_gift,
first_sponsorship,
null
donor_id
integer | null

Donor id. Validation: nullable, integer.

search
string | null

Search. Validation: nullable, string, max:255.

Maximum string length: 255
date_from
string<date-time> | null

Date from. Validation: nullable, date.

date_to
string<date-time> | null

Date to. Validation: nullable, date.

lookahead_days
integer | null

Lookahead days. Validation: nullable, integer, min:1, max:366.

Required range: 1 <= x <= 366
timing
enum<string> | null

Timing. Validation: nullable; allowed values: all, current_window, last_30_days, last_90_days, next_7_days, next_30_days, next_60_days, next_90_days.

Available options:
all,
current_window,
last_30_days,
last_90_days,
next_7_days,
next_30_days,
next_60_days,
next_90_days,
null
anniversary_year_min
integer | null

Anniversary year min. Validation: nullable, integer, min:1, max:200.

Required range: 1 <= x <= 200
anniversary_year_max
integer | null

Anniversary year max. Validation: nullable, integer, min:1, max:200. Must be at least anniversary_year_min when that minimum is supplied.

Required range: 1 <= x <= 200
giving_gap_min
integer | null

Giving gap min. Validation: nullable, integer, min:0, max:200.

Required range: 0 <= x <= 200
giving_gap_max
integer | null

Giving gap max. Validation: nullable, integer, min:0, max:200. Must be at least giving_gap_min when that minimum is supplied.

Required range: 0 <= x <= 200
fundraiser_user_id
string | null

Fundraiser user id. Validation: nullable, string, regex:/^(all|unassigned|[1-9][0-9]*)$/.

Pattern: ^(all|unassigned|[1-9][0-9]*)$
state
string | null

State. Validation: nullable, string, max:100.

Maximum string length: 100
group_by_household
boolean | null

Group compatible relationship work by household. Boolean-like query strings are normalized before validation.

page
integer | null

Page. Validation: nullable, integer, min:1.

Required range: x >= 1
per_page
integer | null

Per page. Validation: nullable, integer, min:10, max:100.

Required range: 10 <= x <= 100

Response

Operation result.

status
string
Example:

"success"

data
object

Paginated opportunities; summary counts cover the durable donor/milestone/year/gap scope across statuses.