{
"opencollection": "1.0.0",
"info": {
"name": "API Reference subpackage_advertisement_opportunities subpackage_referralProgram API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "subpackage_referralProgram",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get referral program OAuth Scope: referral_program:read",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.beehiiv.com/v2/publications/:publicationId/referral_program",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "publicationId",
"value": "",
"type": "path",
"description": "The prefixed ID of the publication object"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10).
If not specified, results 1-10 from page 1 will be returned."
}
]
},
"docs": "Retrieve details about the publication's referral program, including milestones and rewards."
}
]
}
],
"bundled": true
}