Skip to main content
GET
/
admin
/
fields
/
options
/
{program_id}
/
{type}
Get Detailed Field Options
curl --request GET \
  --url https://api.helpyousponsor.com/v1/admin/fields/options/{program_id}/{type} \
  --header 'X-HYS-API-Key: <api-key>'
{
  "data": {
    "program": {},
    "fieldOptions": {},
    "fields": [
      {}
    ],
    "type": "<string>",
    "reports": [
      {}
    ],
    "details": [
      {}
    ]
  }
}

Authorizations

​
X-HYS-API-Key
string
header
required

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

Path Parameters

​
program_id
string
required

Program ID for which to fetch field options, or 'all' for all programs

​
type
string
required

Type of the field options to retrieve

Example:

"all or available"

Response

200 - application/json

Detailed field options retrieved successfully

​
data
object