{
"opencollection": "1.0.0",
"info": {
"name": "API Reference subpackage_advertisement_opportunities subpackage_publications API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "subpackage_publications",
"type": "folder"
},
"items": [
{
"info": {
"name": "List publications OAuth Scope: publications:read",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.beehiiv.com/v2/publications",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "expand",
"value": "",
"type": "query",
"description": "Optionally expand the results by adding additional information like subscription counts and engagement stats."
},
{
"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."
},
{
"name": "direction",
"value": "",
"type": "query",
"description": "The direction that the results are sorted in. Defaults to asc
`asc` - Ascending, sorts from smallest to largest.
`desc` - Descending, sorts from largest to smallest."
},
{
"name": "order_by",
"value": "",
"type": "query",
"description": "The field that the results are sorted by. Defaults to created
`created` - The time in which the publication was first created.
`name` - The name of the publication."
}
]
},
"docs": "Retrieve all publications associated with your API key."
},
{
"info": {
"name": "Get publication OAuth Scope: publications:read",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.beehiiv.com/v2/publications/:publicationId",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "publicationId",
"value": "",
"type": "path",
"description": "The prefixed ID of the publication object"
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "Optionally expand the results by adding additional information like subscription counts and engagement stats."
}
]
},
"docs": "Retrieve a single publication"
}
]
}
],
"bundled": true
}