Skip to main content
GET
/
dashboard
Get Dashboard Data
curl --request GET \
  --url https://api.helpyousponsor.com/v1/dashboard \
  --header 'X-HYS-API-Key: <api-key>'
{
  "data": {
    "org": {},
    "organization": "Organization Name"
  },
  "plan": "pro",
  "amount": 39,
  "last_payment_date": "2022-12-31",
  "last_payment_amount": 39,
  "client_status": "active"
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.helpyousponsor.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-HYS-API-Key
string
header
required

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

Response

200 - application/json

Dashboard data

​
data
object
​
plan
string
Example:

"pro"

​
amount
number
Example:

39

​
last_payment_date
string
Example:

"2022-12-31"

​
last_payment_amount
number
Example:

39

​
client_status
string
Example:

"active"