{
"info": {
"_postman_id": "3b1508fa-9a78-475e-afc2-45dc33ea745f",
"name": "API Reference subpackage_advertisement_opportunities subpackage_referralProgram API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"createdAt": "2026-07-28T01:13:04.000Z",
"updatedAt": "2026-07-28T01:13:04.000Z",
"lastUpdatedBy": "35240",
"uid": "35240-3b1508fa-9a78-475e-afc2-45dc33ea745f"
},
"item": [
{
"name": "publications",
"item": [
{
"name": "{publicationId}",
"item": [
{
"name": "referral_program",
"item": [
{
"name": "Get referral program OAuth Scope: referral_program:read",
"id": "e964e980-8ee9-46fb-8f05-ea29e8932990",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/referral_program?limit=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"referral_program"
],
"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": ""
}
],
"variable": [
{
"id": "1bd8d83b-acfc-4f0a-8753-b9b131b89f15",
"key": "publicationId",
"value": "",
"description": "(Required) The prefixed ID of the publication object"
}
]
},
"description": "Retrieve details about the publication's referral program, including milestones and rewards."
},
"response": [
{
"id": "3ac61f9b-7e4f-4008-a3c8-9e1b9c3ac6c7",
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/referral_program?limit=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"referral_program"
],
"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": ""
}
],
"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 \"auto_fulfill\": \"\",\n \"num_referrals\": \"\",\n \"reward\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"type\": \"physical\"\n }\n },\n {\n \"id\": \"\",\n \"auto_fulfill\": \"\",\n \"num_referrals\": \"\",\n \"reward\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"type\": \"premium_gift\"\n }\n }\n ],\n \"limit\": \"\",\n \"page\": 1,\n \"total_results\": \"\",\n \"total_pages\": \"\"\n}",
"createdAt": "2026-07-28T01:13:05.000Z",
"updatedAt": "2026-07-28T01:13:05.000Z",
"uid": "35240-3ac61f9b-7e4f-4008-a3c8-9e1b9c3ac6c7"
},
{
"id": "e4e68233-9387-482c-abbe-e686f598019c",
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/referral_program?limit=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"referral_program"
],
"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": ""
}
],
"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:13:05.000Z",
"updatedAt": "2026-07-28T01:13:05.000Z",
"uid": "35240-e4e68233-9387-482c-abbe-e686f598019c"
},
{
"id": "cda28a3d-6cc9-440e-9753-f2472cbe7eb5",
"name": "Resource Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/referral_program?limit=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"referral_program"
],
"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": ""
}
],
"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:13:05.000Z",
"updatedAt": "2026-07-28T01:13:05.000Z",
"uid": "35240-cda28a3d-6cc9-440e-9753-f2472cbe7eb5"
},
{
"id": "b36901bc-2178-40e0-94f3-cd10747907ee",
"name": "Rate Limit Exceeded",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/referral_program?limit=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"referral_program"
],
"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": ""
}
],
"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:13:05.000Z",
"updatedAt": "2026-07-28T01:13:05.000Z",
"uid": "35240-b36901bc-2178-40e0-94f3-cd10747907ee"
},
{
"id": "a63c8e63-436c-43c2-8047-c30d33aacccb",
"name": "Internal Server Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/referral_program?limit=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"referral_program"
],
"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": ""
}
],
"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:13:05.000Z",
"updatedAt": "2026-07-28T01:13:05.000Z",
"uid": "35240-a63c8e63-436c-43c2-8047-c30d33aacccb"
}
],
"createdAt": "2026-07-28T01:13:05.000Z",
"updatedAt": "2026-07-28T01:13:05.000Z",
"uid": "35240-e964e980-8ee9-46fb-8f05-ea29e8932990"
}
],
"id": "fddd1a29-b738-4d36-845f-eb6d80072654",
"createdAt": "2026-07-28T01:13:05.000Z",
"updatedAt": "2026-07-28T01:13:05.000Z",
"uid": "35240-fddd1a29-b738-4d36-845f-eb6d80072654"
}
],
"id": "67e26c8c-53e3-4d3c-94d1-7aa6c7efc77b",
"createdAt": "2026-07-28T01:13:05.000Z",
"updatedAt": "2026-07-28T01:13:05.000Z",
"uid": "35240-67e26c8c-53e3-4d3c-94d1-7aa6c7efc77b"
}
],
"id": "3239a09f-8cea-44cd-a237-5487948c7bfa",
"createdAt": "2026-07-28T01:13:05.000Z",
"updatedAt": "2026-07-28T01:13:05.000Z",
"uid": "35240-3239a09f-8cea-44cd-a237-5487948c7bfa"
}
],
"variable": [
{
"key": "baseUrl",
"value": "https://api.beehiiv.com/v2"
}
]
}