Skip to main content
GET
Show a public peer-to-peer recipient profile

Path Parameters

clientSlugOrId
string
required

Organization identifier from the public URL. The controller accepts a numeric client id or a slug generated from the client organization name.

programSlug
string
required

Peer-to-peer program slug in name-id format. The trailing id scopes the program lookup after the client is resolved.

recipientSlug
string
required

Recipient slug in name-id format. The controller extracts the trailing entity id and only returns it when the entity is visible and belongs to the peer-to-peer program.

Response

Public recipient profile.

id
integer
required

Recipient entity id.

Example:

501

name
string
required

Recipient display name resolved through donor/entity naming rules.

Example:

"Jane Student"

slug
string
required

Canonical name-id slug for the profile URL.

Example:

"jane-student-501"

peer_to_peer_program
object
required

Parent peer-to-peer campaign summary and public display flags.

entity_id
integer
required

Recipient entity id used as checkout designation.

Example:

501

program_id
integer
required

Program id used by checkout.

Example:

42

client_id
integer
required

Owning client id.

Example:

207

bio
string | null

Public bio from the peer-to-peer profile JSON or bio field fallback.

Example:

"Jane is raising support for school fees."

video_url
string | null

Optional public profile video URL.

Example:

"https://www.youtube.com/watch?v=abc123"

Public social links keyed by platform when the recipient configured them.

donation_target
number<float> | null

Recipient fundraising target from sp_num.

Example:

1200

total_raised
number<float> | null

Recipient donation total. Null when settings hide donation amounts.

Example:

325

progress_percent
number<float> | null

Recipient progress toward target.

Example:

27.08

photo_url
string | null

Public profile image URL when a public profile upload exists.

Example:

"https://s3-us-west-1.amazonaws.com/hys/thumb.jpg"

recent_donations
object[]

Up to ten recent donations, with amount and donor name hidden according to program settings.

accepts_donations
boolean

Whether checkout should allow donations to this recipient.

Example:

true

setting_id
integer | null

Program setting id for checkout.

Example:

901

program_setting_id
integer | null

Duplicate setting id retained for frontend compatibility.

Example:

901

organization_name
string
Example:

"Acme Foundation"