Skip to main content
GET
/
projects
/
{project_id}
/
playlists
/
{playlist_id}
/
settings
Get playlist feed settings
curl --request GET \
  --url https://api.beyondwords.io/v1/projects/{project_id}/playlists/{playlist_id}/settings \
  --header 'X-Api-Key: <api-key>'
import requests

url = "https://api.beyondwords.io/v1/projects/{project_id}/playlists/{playlist_id}/settings"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.beyondwords.io/v1/projects/{project_id}/playlists/{playlist_id}/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.beyondwords.io/v1/projects/{project_id}/playlists/{playlist_id}/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.beyondwords.io/v1/projects/{project_id}/playlists/{playlist_id}/settings"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-Api-Key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.beyondwords.io/v1/projects/{project_id}/playlists/{playlist_id}/settings")
.header("X-Api-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.beyondwords.io/v1/projects/{project_id}/playlists/{playlist_id}/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "title": "Podcast title",
  "enabled": true,
  "description": "This podcast is about...",
  "homepage_url": "https://example.com/my-podcast",
  "image_url": "https://example.com/image.jpeg",
  "apple_categories": {
    "primary_category": "Arts",
    "primary_subcategory": "Books",
    "secondary_category": "Comedy",
    "secondary_subcategory": "Improv"
  },
  "google_categories": [
    "Arts",
    "Society & Culture",
    "Comedy"
  ],
  "language": "en",
  "owner_name": "John Smith",
  "owner_email": "john@example.com",
  "author_names": [
    "John Smith",
    "Jane Doe"
  ],
  "explicit_enabled": false,
  "keywords": [
    "Improv Comedy"
  ],
  "feed_limit": 50
}

Authorizations

X-Api-Key
string
header
required

Path Parameters

project_id
string
required

The numeric ID of your project

playlist_id
string
required

The numeric ID of your playlist

Response

200 - application/json

OK

title
string

The title of the podcast feed

enabled
boolean

Whether or not the podcast feed URL is available

description
string | null

The description of the podcast feed

homepage_url
string | null

The homepage URL of the podcast feed

image_url
string | null

The image URL of the podcast feed

apple_categories
object

Category data for Apple Podcasts and Spotify

google_categories
string[]

An array of Google Podcast categories of the podcast

language
string | null

The podcast feed language

owner_name
string | null

The name of the administrator for the podcast

owner_email
string | null

The email of the administrator for the podcast

author_names
string[]

The names of writers/speakers who contribute to the podcast

explicit_enabled
boolean

Whether or not the podcast contains explicit content

keywords
string[]

An array of keywords to associate with the podcast

feed_limit
integer

The maximum number of podcasts that will appear in the feed

The copyright tag of the podcast feed