Get a group by ID - HelpYouSponsor Docs

GET

admin

groups

{group_id}

Get a group by ID

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

{
  "data": {
    "programs": [
      {}
    ],
    "donors": [
      {}
    ],
    "group": {},
    "all_groups": [
      {}
    ]
  },
  "message": "<string>"
}

Authorizations

X-HYS-API-Key

string

header

required

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

Path Parameters

group_id

integer

required

Response

Successful operation

data

object

Show child attributes

message

string

List a donors and programs

Get a group by ID

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

{
  "data": {
    "programs": [
      {}
    ],
    "donors": [
      {}
    ],
    "group": {},
    "all_groups": [
      {}
    ]
  },
  "message": "<string>"
}