{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:beehiiv/publications-get-all":{"get":{"operationId":"open_data_beehiiv_publications_get_all","summary":"Index","description":"GET /publications","tags":["open-data"],"parameters":[{"name":"expand[]","in":"query","required":false,"description":"Optional list of expandable objects. `stats` - Returns all statistics about the publication(s) `stat_active_subscriptions` - Total number…","schema":{"type":"array","description":"Optional list of expandable objects. `stats` - Returns all statistics about the publication(s) `stat_active_subscriptions` - Total number…"}},{"name":"limit","in":"query","required":false,"description":"A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.","schema":{"type":"integer","default":10,"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","in":"query","required":false,"description":"Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not…","schema":{"type":"integer","default":1,"description":"Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not…"}},{"name":"direction","in":"query","required":false,"description":"The direction that the results are sorted in. Defaults to asc `asc` - Ascending, sorts from smallest to largest. `desc` - Descending,…","schema":{"type":"string","enum":["asc","desc"],"default":"asc","description":"The direction that the results are sorted in. Defaults to asc `asc` - Ascending, sorts from smallest to largest. `desc` - Descending,…"}},{"name":"order_by","in":"query","required":false,"description":"The field that the results are sorted by. Defaults to created `created` - The time in which the publication was first created. `name` -…","schema":{"type":"string","enum":["created","name"],"default":"created","description":"The field that the results are sorted by. Defaults to created `created` - The time in which the publication was first created. `name` -…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/publications-get-single":{"get":{"operationId":"open_data_beehiiv_publications_get_single","summary":"Show","description":"GET /publications/{publicationId}","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"expand[]","in":"query","required":false,"description":"Optional list of expandable objects. `stats` - Returns all statistics about the publication(s) `stat_active_subscriptions` - Total number…","schema":{"type":"array","description":"Optional list of expandable objects. `stats` - Returns all statistics about the publication(s) `stat_active_subscriptions` - Total number…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/posts-get-all":{"get":{"operationId":"open_data_beehiiv_posts_get_all","summary":"Index","description":"GET /publications/{publicationId}/posts","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"expand[]","in":"query","required":false,"description":"Optional list of expandable objects. `stats` - Returns statistics about the post(s) `free_web_content` - Returns the web HTML rendered to…","schema":{"type":"array","description":"Optional list of expandable objects. `stats` - Returns statistics about the post(s) `free_web_content` - Returns the web HTML rendered to…"}},{"name":"audience","in":"query","required":false,"description":"Optionally filter the results by audience","schema":{"type":"string","enum":["free","premium","all"],"default":"all","description":"Optionally filter the results by audience"},"example":"all"},{"name":"platform","in":"query","required":false,"description":"Optionally filter the results by platform. `web` - Posts only published to web. `email` - Posts only published to email. `both` - Posts…","schema":{"type":"string","enum":["web","email","both","all"],"default":"all","description":"Optionally filter the results by platform. `web` - Posts only published to web. `email` - Posts only published to email. `both` - Posts…"},"example":"all"},{"name":"status","in":"query","required":false,"description":"Optionally filter the results by the status of the post. `draft` - not been scheduled. `confirmed` - The post will be active after the…","schema":{"type":"string","enum":["draft","confirmed","archived","all"],"default":"all","description":"Optionally filter the results by the status of the post. `draft` - not been scheduled. `confirmed` - The post will be active after the…"},"example":"all"},{"name":"content_tags[]","in":"query","required":false,"description":"Optionally filter posts by content_tags. Adding a content tag will return any post with that content tag associated to it. Example:…","schema":{"type":"array","description":"Optionally filter posts by content_tags. Adding a content tag will return any post with that content tag associated to it. Example:…"}},{"name":"limit","in":"query","required":false,"description":"A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.","schema":{"type":"integer","default":10,"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","in":"query","required":false,"description":"Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not…","schema":{"type":"integer","default":1,"description":"Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not…"}},{"name":"order_by","in":"query","required":false,"description":"The field that the results are sorted by. Defaults to created `created` - The time in which the post was first created. `publish_date` -…","schema":{"type":"string","enum":["created","publish_date","displayed_date"],"default":"created","description":"The field that the results are sorted by. Defaults to created `created` - The time in which the post was first created. `publish_date` -…"}},{"name":"direction","in":"query","required":false,"description":"The direction that the results are sorted in. Defaults to asc `asc` - Ascending, sorts from smallest to largest. `desc` - Descending,…","schema":{"type":"string","enum":["asc","desc"],"default":"asc","description":"The direction that the results are sorted in. Defaults to asc `asc` - Ascending, sorts from smallest to largest. `desc` - Descending,…"}},{"name":"hidden_from_feed","in":"query","required":false,"description":"Optionally filter the results by the `hidden_from_feed` attribute of the post. `all` - Does not restrict results by `hidden_from_feed`.…","schema":{"type":"string","enum":["all","true","false"],"default":"all","description":"Optionally filter the results by the `hidden_from_feed` attribute of the post. `all` - Does not restrict results by `hidden_from_feed`.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/posts-get-single":{"get":{"operationId":"open_data_beehiiv_posts_get_single","summary":"Show","description":"GET /publications/{publicationId}/posts/{postId}","tags":["open-data"],"parameters":[{"name":"postId","in":"query","required":true,"description":"The prefixed ID of the post object","schema":{"type":"string","description":"The prefixed ID of the post object"}},{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"expand[]","in":"query","required":false,"description":"Optional list of expandable objects. `stats` - Returns statistics about the post(s) `free_web_content` - Returns the web HTML rendered to…","schema":{"type":"array","description":"Optional list of expandable objects. `stats` - Returns statistics about the post(s) `free_web_content` - Returns the web HTML rendered to…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/posts-destroy-post":{"post":{"operationId":"open_data_beehiiv_posts_destroy_post","summary":"Destroy","description":"DELETE /publications/{publicationId}/posts/{postId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["postId","publicationId"],"properties":{"postId":{"type":"string","description":"The prefixed ID of the post object"},"publicationId":{"type":"string","description":"The prefixed ID of the publication object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/subscriptions-get-all":{"get":{"operationId":"open_data_beehiiv_subscriptions_get_all","summary":"Index","description":"GET /publications/{publicationId}/subscriptions","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"expand[]","in":"query","required":false,"description":"Optional list of expandable objects. `subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with.…","schema":{"type":"array","description":"Optional list of expandable objects. `subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with.…"}},{"name":"status","in":"query","required":false,"description":"Optionally filter the results by a status","schema":{"type":"string","enum":["validating","invalid","pending","active","inactive","all"],"default":"all","description":"Optionally filter the results by a status"}},{"name":"tier","in":"query","required":false,"description":"Optionally filter the results by a their tier","schema":{"type":"string","enum":["free","premium","all"],"default":"all","description":"Optionally filter the results by a their tier"},"example":"all"},{"name":"premium_tiers[]","in":"query","required":false,"description":"Optionally filter the results by one or multiple premium tiers","schema":{"type":"array","description":"Optionally filter the results by one or multiple premium tiers"}},{"name":"premium_tier_ids[]","in":"query","required":false,"description":"Optionally filter the results by one or multiple premium tier ids","schema":{"type":"array","description":"Optionally filter the results by one or multiple premium tier ids"}},{"name":"limit","in":"query","required":false,"description":"A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.","schema":{"type":"integer","default":10,"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","in":"query","required":false,"description":"Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not…","schema":{"type":"integer","default":1,"description":"Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not…"}},{"name":"email","in":"query","required":false,"description":"Optional email address to find a subscription. This param must be an exact match and is case insensitive.","schema":{"type":"string","description":"Optional email address to find a subscription. This param must be an exact match and is case insensitive."}},{"name":"order_by","in":"query","required":false,"description":"The field that the results are sorted by. Defaults to created `created` - The time in which the subscription was first created. `email` -…","schema":{"type":"string","enum":["created","email"],"default":"created","description":"The field that the results are sorted by. Defaults to created `created` - The time in which the subscription was first created. `email` -…"}},{"name":"direction","in":"query","required":false,"description":"The direction that the results are sorted in. Defaults to asc `asc` - Ascending, sorts from smallest to largest. `desc` - Descending,…","schema":{"type":"string","enum":["asc","desc"],"default":"asc","description":"The direction that the results are sorted in. Defaults to asc `asc` - Ascending, sorts from smallest to largest. `desc` - Descending,…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/subscriptions-create-new":{"post":{"operationId":"open_data_beehiiv_subscriptions_create_new","summary":"Create","description":"POST /publications/{publicationId}/subscriptions","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["publicationId","body"],"properties":{"publicationId":{"type":"string","description":"The prefixed ID of the publication object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/subscriptions-bulk-update-status":{"post":{"operationId":"open_data_beehiiv_subscriptions_bulk_update_status","summary":"Bulk Update Status","description":"PUT /publications/{publicationId}/subscriptions","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["publicationId"],"properties":{"publicationId":{"type":"string","description":"The prefixed ID of the publication object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/subscriptions-bulk-update-status-2":{"post":{"operationId":"open_data_beehiiv_subscriptions_bulk_update_status_2","summary":"Bulk Update Status","description":"PATCH /publications/{publicationId}/subscriptions","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["publicationId"],"properties":{"publicationId":{"type":"string","description":"The prefixed ID of the publication object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/subscriptions-get-single":{"get":{"operationId":"open_data_beehiiv_subscriptions_get_single","summary":"Show","description":"GET /publications/{publicationId}/subscriptions/{subscriptionId}","tags":["open-data"],"parameters":[{"name":"subscriptionId","in":"query","required":true,"description":"The prefixed ID of the subscription object","schema":{"type":"string","description":"The prefixed ID of the subscription object"}},{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"expand[]","in":"query","required":false,"description":"Optional list of expandable objects. `subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with.…","schema":{"type":"array","description":"Optional list of expandable objects. `subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/subscriptions-update-subscriber":{"post":{"operationId":"open_data_beehiiv_subscriptions_update_subscriber","summary":"Update","description":"PUT /publications/{publicationId}/subscriptions/{subscriptionId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriptionId","publicationId","body"],"properties":{"subscriptionId":{"type":"string","description":"The prefixed ID of the subscription object"},"publicationId":{"type":"string","description":"The prefixed ID of the publication object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/subscriptions-update-subscriber-2":{"post":{"operationId":"open_data_beehiiv_subscriptions_update_subscriber_2","summary":"Update","description":"PATCH /publications/{publicationId}/subscriptions/{subscriptionId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriptionId","publicationId","body"],"properties":{"subscriptionId":{"type":"string","description":"The prefixed ID of the subscription object"},"publicationId":{"type":"string","description":"The prefixed ID of the publication object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/subscriptions-delete-subscription":{"post":{"operationId":"open_data_beehiiv_subscriptions_delete_subscription","summary":"Delete","description":"DELETE /publications/{publicationId}/subscriptions/{subscriptionId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriptionId","publicationId"],"properties":{"subscriptionId":{"type":"string","description":"The prefixed ID of the subscription object"},"publicationId":{"type":"string","description":"The prefixed ID of the publication object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/subscriptions-show-single-by-subscriber-id":{"get":{"operationId":"open_data_beehiiv_subscriptions_show_single_by_subscriber_id","summary":"Show","description":"GET /publications/{publicationId}/subscriptions/by_subscriber_id/{subscriberId}","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"subscriberId","in":"query","required":true,"description":"The ID of the subscriber object","schema":{"type":"string","description":"The ID of the subscriber object"}},{"name":"expand[]","in":"query","required":false,"description":"Optional list of expandable objects. `subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with.…","schema":{"type":"array","description":"Optional list of expandable objects. `subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/subscriptions-get-single-by-email":{"get":{"operationId":"open_data_beehiiv_subscriptions_get_single_by_email","summary":"Show","description":"GET /publications/{publicationId}/subscriptions/by_email/{email}","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"email","in":"query","required":true,"description":"The ID of the subscriber object","schema":{"type":"string","description":"The ID of the subscriber object"}},{"name":"expand[]","in":"query","required":false,"description":"Optional list of expandable objects. `subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with.…","schema":{"type":"array","description":"Optional list of expandable objects. `subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/subscriptions-bulk-update-fields":{"post":{"operationId":"open_data_beehiiv_subscriptions_bulk_update_fields","summary":"Bulk Update","description":"PUT /publications/{publicationId}/subscriptions/bulk_actions","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["publicationId"],"properties":{"publicationId":{"type":"string","description":"The prefixed ID of the publication object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/subscriptions-bulk-update-fields-2":{"post":{"operationId":"open_data_beehiiv_subscriptions_bulk_update_fields_2","summary":"Bulk Update","description":"PATCH /publications/{publicationId}/subscriptions/bulk_actions","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["publicationId"],"properties":{"publicationId":{"type":"string","description":"The prefixed ID of the publication object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/segments-get-all":{"get":{"operationId":"open_data_beehiiv_segments_get_all","summary":"Index","description":"GET /publications/{publicationId}/segments","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"type","in":"query","required":false,"description":"Optionally filter the results by the segment's type.","schema":{"type":"string","enum":["dynamic","static","manual","all"],"default":"all","description":"Optionally filter the results by the segment's type."}},{"name":"status","in":"query","required":false,"description":"Optionally filter the results by the segment's status.","schema":{"type":"string","enum":["pending","processing","completed","failed","all"],"default":"all","description":"Optionally filter the results by the segment's status."}},{"name":"limit","in":"query","required":false,"description":"A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.","schema":{"type":"integer","default":10,"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","in":"query","required":false,"description":"Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not…","schema":{"type":"integer","default":1,"description":"Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not…"}},{"name":"order_by","in":"query","required":false,"description":"The field that the results are sorted by. Defaults to created `created` - The time in which the segment was first created.…","schema":{"type":"string","enum":["created","last_calculated"],"default":"created","description":"The field that the results are sorted by. Defaults to created `created` - The time in which the segment was first created.…"}},{"name":"direction","in":"query","required":false,"description":"The direction that the results are sorted in. Defaults to asc `asc` - Ascending, sorts from smallest to largest. `desc` - Descending,…","schema":{"type":"string","enum":["asc","desc"],"default":"asc","description":"The direction that the results are sorted in. Defaults to asc `asc` - Ascending, sorts from smallest to largest. `desc` - Descending,…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/segments-get-single":{"get":{"operationId":"open_data_beehiiv_segments_get_single","summary":"Show","description":"GET /publications/{publicationId}/segments/{segmentId}","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"segmentId","in":"query","required":true,"description":"The prefixed ID of the segment object","schema":{"type":"string","description":"The prefixed ID of the segment object"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/segments-delete-segment":{"post":{"operationId":"open_data_beehiiv_segments_delete_segment","summary":"Delete","description":"DELETE /publications/{publicationId}/segments/{segmentId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["publicationId","segmentId"],"properties":{"publicationId":{"type":"string","description":"The prefixed ID of the publication object"},"segmentId":{"type":"string","description":"The prefixed ID of the segment object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/segments-get-subscriber-ids":{"get":{"operationId":"open_data_beehiiv_segments_get_subscriber_ids","summary":"Expand Results","description":"GET /publications/{publicationId}/segments/{segmentId}/results","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"segmentId","in":"query","required":true,"description":"The prefixed ID of the segment object","schema":{"type":"string","description":"The prefixed ID of the segment object"}},{"name":"limit","in":"query","required":false,"description":"A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.","schema":{"type":"integer","default":10,"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","in":"query","required":false,"description":"Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not…","schema":{"type":"integer","default":1,"description":"Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/email-blasts-get-all":{"get":{"operationId":"open_data_beehiiv_email_blasts_get_all","summary":"Index","description":"GET /publications/{publicationId}/email_blasts","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"expand[]","in":"query","required":false,"description":"Optional list of expandable objects. `stats` - Returns statistics about the email blast(s) `free_email_content` - Returns the email HTML…","schema":{"type":"array","description":"Optional list of expandable objects. `stats` - Returns statistics about the email blast(s) `free_email_content` - Returns the email HTML…"}},{"name":"limit","in":"query","required":false,"description":"A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.","schema":{"type":"integer","default":10,"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","in":"query","required":false,"description":"Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not…","schema":{"type":"integer","default":1,"description":"Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not…"}},{"name":"direction","in":"query","required":false,"description":"The direction that the results are sorted in. Defaults to asc `asc` - Ascending, sorts from smallest to largest. `desc` - Descending,…","schema":{"type":"string","enum":["asc","desc"],"default":"asc","description":"The direction that the results are sorted in. Defaults to asc `asc` - Ascending, sorts from smallest to largest. `desc` - Descending,…"}},{"name":"order_by","in":"query","required":false,"description":"The field that the results are sorted by. Defaults to created `created` - The time in which the segment was first created. `last_sent` -…","schema":{"type":"string","enum":["created","last_sent"],"default":"created","description":"The field that the results are sorted by. Defaults to created `created` - The time in which the segment was first created. `last_sent` -…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/email-blasts-get-email-blast":{"get":{"operationId":"open_data_beehiiv_email_blasts_get_email_blast","summary":"Show","description":"GET /publications/{publicationId}/email_blasts/{emailBlastId}","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"emailBlastId","in":"query","required":true,"description":"The prefixed ID of the email blast object","schema":{"type":"string","description":"The prefixed ID of the email blast object"}},{"name":"expand[]","in":"query","required":false,"description":"Optional list of expandable objects. `stats` - Returns statistics about the email blast(s) `free_email_content` - Returns the email HTML…","schema":{"type":"array","description":"Optional list of expandable objects. `stats` - Returns statistics about the email blast(s) `free_email_content` - Returns the email HTML…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/referral-program-details-retrieve":{"get":{"operationId":"open_data_beehiiv_referral_program_details_retrieve","summary":"Show","description":"GET /publications/{publicationId}/referral_program","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"limit","in":"query","required":false,"description":"A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.","schema":{"type":"integer","default":10,"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","in":"query","required":false,"description":"Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not…","schema":{"type":"integer","default":1,"description":"Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/custom-fields-get-all":{"get":{"operationId":"open_data_beehiiv_custom_fields_get_all","summary":"Index","description":"GET /publications/{publicationId}/custom_fields","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/custom-fields-create-publication-custom-field":{"post":{"operationId":"open_data_beehiiv_custom_fields_create_publication_custom_field","summary":"Create","description":"POST /publications/{publicationId}/custom_fields","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["publicationId"],"properties":{"publicationId":{"type":"string","description":"The prefixed ID of the publication object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/custom-fields-show-specific":{"get":{"operationId":"open_data_beehiiv_custom_fields_show_specific","summary":"Show","description":"GET /publications/{publicationId}/custom_fields/{id}","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"id","in":"query","required":true,"description":"The ID of the Custom Fields object","schema":{"type":"string","description":"The ID of the Custom Fields object"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/custom-fields-update-publication-custom-field":{"post":{"operationId":"open_data_beehiiv_custom_fields_update_publication_custom_field","summary":"Update","description":"PUT /publications/{publicationId}/custom_fields/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["publicationId","id"],"properties":{"publicationId":{"type":"string","description":"The prefixed ID of the publication object"},"id":{"type":"string","description":"The ID of the Custom Fields object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/custom-fields-update-publication-custom-field-2":{"post":{"operationId":"open_data_beehiiv_custom_fields_update_publication_custom_field_2","summary":"Update","description":"PATCH /publications/{publicationId}/custom_fields/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["publicationId","id"],"properties":{"publicationId":{"type":"string","description":"The prefixed ID of the publication object"},"id":{"type":"string","description":"The ID of the Custom Fields object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/custom-fields-delete-publication-custom-field":{"post":{"operationId":"open_data_beehiiv_custom_fields_delete_publication_custom_field","summary":"Delete","description":"DELETE /publications/{publicationId}/custom_fields/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["publicationId","id"],"properties":{"publicationId":{"type":"string","description":"The prefixed ID of the publication object"},"id":{"type":"string","description":"The ID of the Custom Fields object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/bulk-subscription-updates-list-subscription-updates":{"get":{"operationId":"open_data_beehiiv_bulk_subscription_updates_list_subscription_updates","summary":"Index","description":"GET /publications/{publicationId}/bulk_subscription_updates","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/bulk-subscription-updates-get-single-update":{"get":{"operationId":"open_data_beehiiv_bulk_subscription_updates_get_single_update","summary":"Show","description":"GET /publications/{publicationId}/bulk_subscription_updates/{id}","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"id","in":"query","required":true,"description":"The ID of the Subscription Update object","schema":{"type":"string","description":"The ID of the Subscription Update object"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/automation-journeys-get-all":{"get":{"operationId":"open_data_beehiiv_automation_journeys_get_all","summary":"Index","description":"GET /publications/{publicationId}/automations/{automationId}/journeys","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"automationId","in":"query","required":true,"description":"The prefixed ID of the automation object","schema":{"type":"string","description":"The prefixed ID of the automation object"}},{"name":"status","in":"query","required":false,"description":"Optionally filter the results by a status","schema":{"type":"string","enum":["in_progress","completed","exited_early","all"],"default":"all","description":"Optionally filter the results by a status"}},{"name":"limit","in":"query","required":false,"description":"A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.","schema":{"type":"integer","default":10,"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","in":"query","required":false,"description":"Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not…","schema":{"type":"integer","default":1,"description":"Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not…"}},{"name":"subscription_id","in":"query","required":false,"description":"Optionally filter the results by a subscription id","schema":{"type":"string","description":"Optionally filter the results by a subscription id"}},{"name":"email","in":"query","required":false,"description":"Optionally filter the results by a subscription email address. This param must be an exact match and is case insensitive.","schema":{"type":"string","description":"Optionally filter the results by a subscription email address. This param must be an exact match and is case insensitive."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/automation-journeys-add-existing-subscription":{"post":{"operationId":"open_data_beehiiv_automation_journeys_add_existing_subscription","summary":"Create","description":"POST /publications/{publicationId}/automations/{automationId}/journeys","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["publicationId","automationId"],"properties":{"publicationId":{"type":"string","description":"The prefixed ID of the publication object"},"automationId":{"type":"string","description":"The prefixed ID of the automation object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/automation-journeys-show-journey-details":{"get":{"operationId":"open_data_beehiiv_automation_journeys_show_journey_details","summary":"Show","description":"GET /publications/{publicationId}/automations/{automationId}/journeys/{automationJourneyId}","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"automationId","in":"query","required":true,"description":"The prefixed ID of the automation object","schema":{"type":"string","description":"The prefixed ID of the automation object"}},{"name":"automationJourneyId","in":"query","required":true,"description":"The prefixed automation journey id","schema":{"type":"string","description":"The prefixed automation journey id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/automations-index":{"get":{"operationId":"open_data_beehiiv_automations_index","summary":"Index","description":"GET /publications/{publicationId}/automations","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"limit","in":"query","required":false,"description":"A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.","schema":{"type":"integer","default":10,"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","in":"query","required":false,"description":"Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not…","schema":{"type":"integer","default":1,"description":"Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/automations-show-details":{"get":{"operationId":"open_data_beehiiv_automations_show_details","summary":"Show","description":"GET /publications/{publicationId}/automations/{automationId}","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"automationId","in":"query","required":true,"description":"The prefixed ID of the automation object","schema":{"type":"string","description":"The prefixed ID of the automation object"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/subscription-tags-create-new":{"post":{"operationId":"open_data_beehiiv_subscription_tags_create_new","summary":"Post","description":"POST /publications/{publicationId}/subscriptions/{subscriptionId}/tags","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["publicationId","subscriptionId"],"properties":{"publicationId":{"type":"string"},"subscriptionId":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/tiers-get-all":{"get":{"operationId":"open_data_beehiiv_tiers_get_all","summary":"Index","description":"GET /publications/{publicationId}/tiers","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"expand[]","in":"query","required":false,"description":"Optional list of expandable objects. `stats` - Returns statistics about the tier(s). `prices` - Returns prices for the tier(s).","schema":{"type":"array","description":"Optional list of expandable objects. `stats` - Returns statistics about the tier(s). `prices` - Returns prices for the tier(s)."}},{"name":"limit","in":"query","required":false,"description":"A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.","schema":{"type":"integer","default":10,"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","in":"query","required":false,"description":"Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not…","schema":{"type":"integer","default":1,"description":"Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not…"}},{"name":"direction","in":"query","required":false,"description":"The direction that the results are sorted in. Defaults to asc `asc` - Ascending, sorts from smallest to largest. `desc` - Descending,…","schema":{"type":"string","enum":["asc","desc"],"default":"asc","description":"The direction that the results are sorted in. Defaults to asc `asc` - Ascending, sorts from smallest to largest. `desc` - Descending,…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/tiers-create-new-tier":{"post":{"operationId":"open_data_beehiiv_tiers_create_new_tier","summary":"Create","description":"POST /publications/{publicationId}/tiers","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["publicationId"],"properties":{"publicationId":{"type":"string","description":"The prefixed ID of the publication object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/tiers-get-single-tier":{"get":{"operationId":"open_data_beehiiv_tiers_get_single_tier","summary":"Show","description":"GET /publications/{publicationId}/tiers/{tierId}","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"tierId","in":"query","required":true,"description":"The prefixed ID of the tier object","schema":{"type":"string","description":"The prefixed ID of the tier object"}},{"name":"expand[]","in":"query","required":false,"description":"Optional list of expandable objects. `stats` - Returns statistics about the tier(s). `prices` - Returns prices for the tier(s).","schema":{"type":"array","description":"Optional list of expandable objects. `stats` - Returns statistics about the tier(s). `prices` - Returns prices for the tier(s)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/tiers-update-existing-tier":{"post":{"operationId":"open_data_beehiiv_tiers_update_existing_tier","summary":"Update","description":"PUT /publications/{publicationId}/tiers/{tierId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["publicationId","tierId"],"properties":{"publicationId":{"type":"string","description":"The prefixed ID of the publication object"},"tierId":{"type":"string","description":"The prefixed ID of the tier object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/tiers-update-existing-tier-2":{"post":{"operationId":"open_data_beehiiv_tiers_update_existing_tier_2","summary":"Update","description":"PATCH /publications/{publicationId}/tiers/{tierId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["publicationId","tierId"],"properties":{"publicationId":{"type":"string","description":"The prefixed ID of the publication object"},"tierId":{"type":"string","description":"The prefixed ID of the tier object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/webhooks-get-all":{"get":{"operationId":"open_data_beehiiv_webhooks_get_all","summary":"Index","description":"GET /publications/{publicationId}/webhooks","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"limit","in":"query","required":false,"description":"A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.","schema":{"type":"integer","default":10,"description":"A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/webhooks-create-new-webhook":{"post":{"operationId":"open_data_beehiiv_webhooks_create_new_webhook","summary":"Create","description":"POST /publications/{publicationId}/webhooks","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["publicationId"],"properties":{"publicationId":{"type":"string","description":"The prefixed ID of the publication object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/webhooks-get-specific":{"get":{"operationId":"open_data_beehiiv_webhooks_get_specific","summary":"Show","description":"GET /publications/{publicationId}/webhooks/{webhookId}","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"The prefixed ID of the publication object","schema":{"type":"string","description":"The prefixed ID of the publication object"}},{"name":"webhookId","in":"query","required":true,"description":"The prefixed ID of the webhook object","schema":{"type":"string","description":"The prefixed ID of the webhook object"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:beehiiv/webhooks-delete-subscription":{"post":{"operationId":"open_data_beehiiv_webhooks_delete_subscription","summary":"Delete","description":"DELETE /publications/{publicationId}/webhooks/{webhookId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["publicationId","webhookId"],"properties":{"publicationId":{"type":"string","description":"The prefixed ID of the publication object"},"webhookId":{"type":"string","description":"The prefixed ID of the webhook object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}