{
"info": {
"_postman_id": "24a33d0e-389d-45c8-9a6b-4eac3a3b5afd",
"name": "API Reference subpackage_advertisement_opportunities subpackage_newsletterLists API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"createdAt": "2026-07-28T01:12:45.000Z",
"updatedAt": "2026-07-28T01:12:46.000Z",
"lastUpdatedBy": "35240",
"uid": "35240-24a33d0e-389d-45c8-9a6b-4eac3a3b5afd"
},
"item": [
{
"name": "publications",
"item": [
{
"name": "{publicationId}",
"item": [
{
"name": "newsletter_lists",
"item": [
{
"name": "{newsletterListId}",
"item": [
{
"name": "Get newsletter list Beta OAuth Scope: newsletter_lists:read",
"id": "b1b8f2d2-5b99-4e33-8837-04a41c3324d9",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/newsletter_lists/:newsletterListId",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"newsletter_lists",
":newsletterListId"
],
"variable": [
{
"id": "0d58e2fb-9bc3-4ad2-b33c-4960ac47bc8b",
"key": "publicationId",
"value": "",
"description": "(Required) The prefixed ID of the publication object"
},
{
"id": "3e82daf9-ef96-4ea8-bd46-37455c1e3c1e",
"key": "newsletterListId",
"value": "",
"description": "(Required) The prefixed ID of the newsletter list object"
}
]
},
"description": "\n Newsletter Lists is currently in beta, the API is subject to change.\n\nRetrieve a single newsletter list belonging to a specific publication."
},
"response": [
{
"id": "a01caf0a-fdae-4cbf-b4dc-aa73227ee8fe",
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/newsletter_lists/:newsletterListId",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"newsletter_lists",
":newsletterListId"
],
"variable": [
{
"key": "publicationId"
},
{
"key": "newsletterListId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"status\": \"draft\",\n \"auto_subscribe\": \"\",\n \"subscriber_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\"\n }\n}",
"createdAt": "2026-07-28T01:12:46.000Z",
"updatedAt": "2026-07-28T01:12:46.000Z",
"uid": "35240-a01caf0a-fdae-4cbf-b4dc-aa73227ee8fe"
},
{
"id": "2b4cc849-8a6f-44cb-9565-f5a9cbf10aa8",
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/newsletter_lists/:newsletterListId",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"newsletter_lists",
":newsletterListId"
],
"variable": [
{
"key": "publicationId"
},
{
"key": "newsletterListId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"status\": \"\",\n \"statusText\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}",
"createdAt": "2026-07-28T01:12:46.000Z",
"updatedAt": "2026-07-28T01:12:46.000Z",
"uid": "35240-2b4cc849-8a6f-44cb-9565-f5a9cbf10aa8"
},
{
"id": "3b6b1b2a-1ad9-4904-8f03-9d981318b8ed",
"name": "Resource Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/newsletter_lists/:newsletterListId",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"newsletter_lists",
":newsletterListId"
],
"variable": [
{
"key": "publicationId"
},
{
"key": "newsletterListId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"status\": \"\",\n \"statusText\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}",
"createdAt": "2026-07-28T01:12:46.000Z",
"updatedAt": "2026-07-28T01:12:46.000Z",
"uid": "35240-3b6b1b2a-1ad9-4904-8f03-9d981318b8ed"
},
{
"id": "6c34ca4c-a2e9-465b-bc99-d4e40112f2a6",
"name": "Rate Limit Exceeded",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/newsletter_lists/:newsletterListId",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"newsletter_lists",
":newsletterListId"
],
"variable": [
{
"key": "publicationId"
},
{
"key": "newsletterListId"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"status\": \"\",\n \"statusText\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}",
"createdAt": "2026-07-28T01:12:46.000Z",
"updatedAt": "2026-07-28T01:12:46.000Z",
"uid": "35240-6c34ca4c-a2e9-465b-bc99-d4e40112f2a6"
},
{
"id": "4a27c3d5-75d2-45fa-a513-e45173fc2459",
"name": "Internal Server Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/newsletter_lists/:newsletterListId",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"newsletter_lists",
":newsletterListId"
],
"variable": [
{
"key": "publicationId"
},
{
"key": "newsletterListId"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"status\": \"\",\n \"statusText\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}",
"createdAt": "2026-07-28T01:12:46.000Z",
"updatedAt": "2026-07-28T01:12:46.000Z",
"uid": "35240-4a27c3d5-75d2-45fa-a513-e45173fc2459"
}
],
"createdAt": "2026-07-28T01:12:46.000Z",
"updatedAt": "2026-07-28T01:12:46.000Z",
"uid": "35240-b1b8f2d2-5b99-4e33-8837-04a41c3324d9"
}
],
"id": "b0768d42-68e7-4f91-a2d6-96a102f32590",
"createdAt": "2026-07-28T01:12:46.000Z",
"updatedAt": "2026-07-28T01:12:46.000Z",
"uid": "35240-b0768d42-68e7-4f91-a2d6-96a102f32590"
},
{
"name": "List newsletter lists Beta OAuth Scope: newsletter_lists:read",
"id": "4c53d494-e0a5-40cc-aa8e-0db809432db5",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/newsletter_lists?limit=&page=&direction=asc",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"newsletter_lists"
],
"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.",
"key": "limit",
"value": ""
},
{
"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.",
"key": "page",
"value": ""
},
{
"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.",
"key": "direction",
"value": "asc"
}
],
"variable": [
{
"id": "68b0b727-c645-4bd7-ae3f-c8b8429756bb",
"key": "publicationId",
"value": "",
"description": "(Required) The prefixed ID of the publication object"
}
]
},
"description": "\n Newsletter Lists is currently in beta, the API is subject to change.\n\nList all newsletter lists for a publication."
},
"response": [
{
"id": "86e3ce60-6ea8-4fcd-8c01-c7f520c23caa",
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/newsletter_lists?limit=&page=&direction=asc",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"newsletter_lists"
],
"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.",
"key": "limit",
"value": ""
},
{
"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.",
"key": "page",
"value": ""
},
{
"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.",
"key": "direction",
"value": "asc"
}
],
"variable": [
{
"key": "publicationId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"status\": \"archived\",\n \"auto_subscribe\": \"\",\n \"subscriber_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"status\": \"draft\",\n \"auto_subscribe\": \"\",\n \"subscriber_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\"\n }\n ],\n \"limit\": \"\",\n \"page\": 1,\n \"total_results\": \"\",\n \"total_pages\": \"\"\n}",
"createdAt": "2026-07-28T01:12:46.000Z",
"updatedAt": "2026-07-28T01:12:46.000Z",
"uid": "35240-86e3ce60-6ea8-4fcd-8c01-c7f520c23caa"
},
{
"id": "8dd694e9-a91e-42e3-8e00-fad1f2961af3",
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/newsletter_lists?limit=&page=&direction=asc",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"newsletter_lists"
],
"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.",
"key": "limit",
"value": ""
},
{
"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.",
"key": "page",
"value": ""
},
{
"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.",
"key": "direction",
"value": "asc"
}
],
"variable": [
{
"key": "publicationId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"status\": \"\",\n \"statusText\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}",
"createdAt": "2026-07-28T01:12:46.000Z",
"updatedAt": "2026-07-28T01:12:46.000Z",
"uid": "35240-8dd694e9-a91e-42e3-8e00-fad1f2961af3"
},
{
"id": "08d901d5-fa58-4a9b-a3e6-5c161c4b1cf1",
"name": "Resource Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/newsletter_lists?limit=&page=&direction=asc",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"newsletter_lists"
],
"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.",
"key": "limit",
"value": ""
},
{
"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.",
"key": "page",
"value": ""
},
{
"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.",
"key": "direction",
"value": "asc"
}
],
"variable": [
{
"key": "publicationId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"status\": \"\",\n \"statusText\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}",
"createdAt": "2026-07-28T01:12:46.000Z",
"updatedAt": "2026-07-28T01:12:46.000Z",
"uid": "35240-08d901d5-fa58-4a9b-a3e6-5c161c4b1cf1"
},
{
"id": "e1bac5e3-70c3-4b0f-be6c-bf5ad5ff75eb",
"name": "Rate Limit Exceeded",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/newsletter_lists?limit=&page=&direction=asc",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"newsletter_lists"
],
"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.",
"key": "limit",
"value": ""
},
{
"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.",
"key": "page",
"value": ""
},
{
"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.",
"key": "direction",
"value": "asc"
}
],
"variable": [
{
"key": "publicationId"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"status\": \"\",\n \"statusText\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}",
"createdAt": "2026-07-28T01:12:46.000Z",
"updatedAt": "2026-07-28T01:12:46.000Z",
"uid": "35240-e1bac5e3-70c3-4b0f-be6c-bf5ad5ff75eb"
},
{
"id": "ecbdd3a2-2be5-4de3-90fc-de48be03ed8a",
"name": "Internal Server Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/newsletter_lists?limit=&page=&direction=asc",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"newsletter_lists"
],
"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.",
"key": "limit",
"value": ""
},
{
"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.",
"key": "page",
"value": ""
},
{
"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.",
"key": "direction",
"value": "asc"
}
],
"variable": [
{
"key": "publicationId"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"status\": \"\",\n \"statusText\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}",
"createdAt": "2026-07-28T01:12:46.000Z",
"updatedAt": "2026-07-28T01:12:46.000Z",
"uid": "35240-ecbdd3a2-2be5-4de3-90fc-de48be03ed8a"
}
],
"createdAt": "2026-07-28T01:12:46.000Z",
"updatedAt": "2026-07-28T01:12:46.000Z",
"uid": "35240-4c53d494-e0a5-40cc-aa8e-0db809432db5"
}
],
"id": "348c8aea-f879-4df5-8561-cbda0d9c0453",
"createdAt": "2026-07-28T01:12:46.000Z",
"updatedAt": "2026-07-28T01:12:46.000Z",
"uid": "35240-348c8aea-f879-4df5-8561-cbda0d9c0453"
}
],
"id": "875ff0a4-31c1-4a9c-82d4-d96b23fdf195",
"createdAt": "2026-07-28T01:12:46.000Z",
"updatedAt": "2026-07-28T01:12:46.000Z",
"uid": "35240-875ff0a4-31c1-4a9c-82d4-d96b23fdf195"
}
],
"id": "d67417bf-f1af-45e5-ad67-07d7366a9fdd",
"createdAt": "2026-07-28T01:12:46.000Z",
"updatedAt": "2026-07-28T01:12:46.000Z",
"uid": "35240-d67417bf-f1af-45e5-ad67-07d7366a9fdd"
}
],
"variable": [
{
"key": "baseUrl",
"value": "https://api.beehiiv.com/v2"
}
]
}