Skip to main content
GET
List eligible replacement recipients

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

donor_entity_id
integer
required

Record ID in the authenticated organization.

Example:

42

Query Parameters

search
string | null

Case-insensitive profile/program text or exact numeric recipient ID.

Maximum string length: 100
Example:

"Jane"

page
integer | null

One-based page.

Required range: x >= 1
Example:

1

per_page
integer | null

Page length, default25.

Required range: 1 <= x <= 100
Example:

25

Response

List eligible replacement recipients completed.

data
object[]
current_page
integer

One-based page.

Example:

42

from
integer | null

First row offset.

Example:

42

to
integer | null

Last row offset.

Example:

42

last_page
integer

Last page.

Example:

42

per_page
integer

Maximum rows per page.

Example:

42

total
integer

Total matching rows.

Example:

12

first_page_url
string | null

Paginator first page url.

Example:

"Example"

last_page_url
string | null

Paginator last page url.

Example:

"Example"

next_page_url
string | null

Paginator next page url.

Example:

"Example"

prev_page_url
string | null

Paginator prev page url.

Example:

"Example"

path
string | null

Paginator path.

Example:

"Example"

sponsorship
object