Get referral program
get_referral_programRetrieve a Beehiiv publication's referral program details and paginated results to inspect referral settings. OAuth access requires referral_program:read.
Instructions
Get referral program. Reads account data. OAuth integrations require referral_program:read.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"publication_id": "<publication_id>"
},
"name": "get_referral_program"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 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. | |
| limit | No | A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10. | |
| account | No | Named private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account. | |
| publication_id | Yes | The prefixed ID of the publication object |