External Feeds

Retrieve items from an external feed

get/external_feeds/{id}/items

Request

  • Base URL
    https://api.buttondown.com/v1
  • URL
    https://api.buttondown.com/v1/external_feeds/{id}/items
  • Auth
    API key in header Authorization

Path parameters

idstring required

Query parameters

expandstring[]

If provided, expand the given field.

pageinteger

The page number of the paginated response.

Example:1

Response

OK

nextstring nullable

The URL to the next page of results, if any.

previousstring nullable

The URL to the previous page of results, if any.

countinteger required

The total number of results across all pages.

Example response

{
  "results": [
    {
      "email": {
        "slug": "welcome-to-the-newsletter"
      }
    }
  ]
}

Changes

    • warning

      removed the optional property //// from the response with the status

    • info

      removed the suppressed enum value from the //// response property for the response status

    • info

      added the optional property ////// to the response with the status