Skip to main content
GET
/
donor
/
{id}
Get a donor
curl --request GET \
  --url https://api.helpyousponsor.com/v1/donor/{id} \
  --header 'X-HYS-API-Key: <api-key>'
{
  "status": "success",
  "data": {
    "status": "Active",
    "profile": {
      "field_key": "field_value"
    },
    "fields": [
      {}
    ],
    "donor": {},
    "hysform": {},
    "profilePic": "",
    "name": "John Doe",
    "details": {},
    "emailsets": {},
    "years": [
      123
    ],
    "template_errors": [
      "<string>"
    ]
  }
}

Authorizations

​
X-HYS-API-Key
string
header
required

API key generated from Developer Settings. Format: hys_...

Path Parameters

​
id
integer
required

ID of the donor to be fetched

Response

Successful operation

​
status
string
Example:

"success"

​
data
object