{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference subpackage_advertisement_opportunities subpackage_automations API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_automations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List automations <Badge intent=\"info\" minimal outlined>OAuth Scope: automations:read</Badge>",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.beehiiv.com/v2/publications/:publicationId/automations",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "publicationId",
                "value": "",
                "type": "path",
                "description": "The prefixed ID of the publication object"
              },
              {
                "name": "expand[]",
                "value": "",
                "type": "query",
                "description": "Optional list of expandable objects."
              },
              {
                "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).<br>If not specified, results 1-10 from page 1 will be returned."
              }
            ]
          },
          "docs": "Retrieve automations for a publication."
        },
        {
          "info": {
            "name": "Get automation <Badge intent=\"info\" minimal outlined>OAuth Scope: automations:read</Badge>",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.beehiiv.com/v2/publications/:publicationId/automations/:automationId",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "publicationId",
                "value": "",
                "type": "path",
                "description": "The prefixed ID of the publication object"
              },
              {
                "name": "automationId",
                "value": "",
                "type": "path",
                "description": "The prefixed ID of the automation object"
              },
              {
                "name": "expand[]",
                "value": "",
                "type": "query",
                "description": "Optional list of expandable objects."
              }
            ]
          },
          "docs": "Retrieve a single automation for a publication."
        },
        {
          "info": {
            "name": "List automation emails",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.beehiiv.com/v2/publications/:publicationId/automations/:automationId/emails",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "publicationId",
                "value": "",
                "type": "path",
                "description": "The prefixed ID of the publication object"
              },
              {
                "name": "automationId",
                "value": "",
                "type": "path",
                "description": "The prefixed ID of the automation 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": "cursor",
                "value": "",
                "type": "query",
                "description": "**Cursor-based pagination (recommended)**: Use this opaque cursor token to fetch the next page of results. Obtain it from the `next_cursor` field of a previous response."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "**Deprecated**: Use `cursor` instead. Pagination returns the results in pages. Limited to 100 pages maximum."
              }
            ]
          },
          "docs": "Retrieve all emails belonging to a specific automation, including engagement statistics for each email."
        }
      ]
    }
  ],
  "bundled": true
}