Get Donor Information - HelpYouSponsor Docs

GET

frontend

donor

dashboard

details

{client_id}

{program_id}

{session_id}

Get Donor Information

curl --request GET \
  --url https://api.helpyousponsor.com/v1/frontend/donor/dashboard/details/{client_id}/{program_id}/{session_id} \
  --header 'session_id: <api-key>'

{
  "client_id": 123,
  "program_id": 123,
  "session_id": "<string>",
  "donor_fields": [
    "<string>"
  ],
  "email": "<string>",
  "username": "<string>",
  "donor_profile": {},
  "do_not_email": true,
  "disable_program_link": "<string>"
}

Authorizations

session_id

string

header

required

Use a session id to authenticate

Path Parameters

client_id

integer

required

Client ID associated with the donor

program_id

integer

required

Program ID associated with the donor

session_id

string

required

Session ID for the donor

Response

Donor information retrieved successfully

client_id

integer

program_id

integer

session_id

string

donor_fields

string[]

string

username

string

donor_profile

object

do_not_email

boolean

disable_program_link

string

Get files for a donor

Get Donor Information

curl --request GET \
  --url https://api.helpyousponsor.com/v1/frontend/donor/dashboard/details/{client_id}/{program_id}/{session_id} \
  --header 'session_id: <api-key>'

{
  "client_id": 123,
  "program_id": 123,
  "session_id": "<string>",
  "donor_fields": [
    "<string>"
  ],
  "email": "<string>",
  "username": "<string>",
  "donor_profile": {},
  "do_not_email": true,
  "disable_program_link": "<string>"
}