Get note details - HelpYouSponsor Docs

GET

admin

notes

{note_id}

{program_id}

Get note details

curl --request GET \
  --url https://api.helpyousponsor.com/v1/admin/notes/{note_id}/{program_id} \
  --header 'X-HYS-API-Key: <api-key>'

{
  "note": {},
  "program_id": 123,
  "type": "<string>"
}

X-HYS-API-Key

string

header

required

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

note_id

integer

required

ID of the note

Example:

1

program_id

string

required

ID of the program

Example:

"donor"

Successful operation

note

object

The edited note

program_id

integer

ID of the program

type

string

Type of the note (entity or donor)

Get note details

curl --request GET \
  --url https://api.helpyousponsor.com/v1/admin/notes/{note_id}/{program_id} \
  --header 'X-HYS-API-Key: <api-key>'

{
  "note": {},
  "program_id": 123,
  "type": "<string>"
}