List podcasts

Podcasts for a site

Pagination

Use page[number] and page[size] parameters to paginate results:

Get first page of 10 items

• GET /v1/podcasts?page[number]=1&page[size]=10

Get second page of 25 items

• GET /v1/podcasts?page[number]=2&page[size]=25

The response includes pagination links and meta data:

{
  "links": {
    "self": "https://api.kajabi.com/v1/podcasts?page[number]=2&page[size]=10",
    "first": "https://api.kajabi.com/v1/podcasts?page[number]=1&page[size]=10",
    "prev": "https://api.kajabi.com/v1/podcasts?page[number]=1&page[size]=10",
    "next": "https://api.kajabi.com/v1/podcasts?page[number]=3&page[size]=10",
    "last": "https://api.kajabi.com/v1/podcasts?page[number]=5&page[size]=10"
  },
  "meta": {
    "total_pages": 5,
    "total_count": 50,
    "current_page": 2
  }
}

Sorting

Use the sort parameter to sort the results:

Sort by title in ascending order

• GET /v1/podcasts?sort=title

Sort by title in descending order

• GET /v1/podcasts?sort=-title

Response will include podcasts sorted by the specified field

{
  "data": [
    {
      "id": "123",
      "type": "podcasts",
      "attributes": {
        "title": "My Podcast A",
        "description": "A great podcast about technology"
      }
    },
    {
      "id": "456",
      "type": "podcasts",
      "attributes": {
        "title": "My Podcast B",
        "description": "Another great podcast about business"
      }
    }
  ]
}

Sparse Fields

Use the fields[podcasts] parameter to request only specific attributes:

Only return title and description attributes

• GET /v1/podcasts?fields[podcasts]=title,description

Response will only include requested fields

{
  "data": [{
    "id": "123",
    "type": "podcasts",
    "attributes": {
      "title": "My Podcast A",
      "description": "A great podcast about technology"
    }
  }]
}

Filter by Site ID

Use the filter[site_id] parameter to get podcasts for a specific site:

Get podcasts for site with ID 123

• GET /v1/podcasts?filter[site_id]=123

Response will only include podcasts for that site

{
  "data": [{
    "id": "456",
    "type": "podcasts",
    "attributes": {
      "title": "My Podcast",
      "description": "A great podcast"
    }
  }]
}

GET /v1/podcasts

List podcasts

cURL

curl --request GET \
  --url https://api.kajabi.com/v1/podcasts \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "<string>",
      "type": "podcasts",
      "attributes": {
        "title": "<string>",
        "description": "<string>",
        "language": "<string>",
        "owner_email": "<string>",
        "author": "<string>",
        "status": "ready",
        "show_type": "episodic",
        "thumbnail_url": "<string>",
        "cover_art_url": "<string>",
        "categories": [
          "<string>"
        ],
        "directories": [
          {
            "id": "<string>",
            "url": "<string>",
            "config": {}
          }
        ],
        "migrated_to_url": "<string>",
        "migrated": true,
        "public": true,
        "ready": true,
        "distribution_ready": true,
        "url": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "site": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        }
      }
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<string>"
  },
  "meta": {
    "total_pages": 123,
    "total_count": 123,
    "current_page": 123
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter[site_id] · string

Filter by site ID, for example ?filter[site_id]=123

filter[title_eq] · string

Filter by exact title match, for example ?filter[title_eq]=My Podcast

filter[title_cont] · string

Filter by title containing text, for example ?filter[title_cont]=technology

filter[status_eq] · string

Filter by status, for example ?filter[status_eq]=ready

filter[show_type_eq] · string

Filter by show type, for example ?filter[show_type_eq]=episodic

sort · string

Sort results by field, for example ?sort=title or ?sort=-title (descending)

page[number] · integer

Page number for pagination, for example ?page[number]=1

page[size] · integer

Number of items per page, for example ?page[size]=10

fields[podcasts] · string

Comma-separated list of fields to include, for example ?fields[podcasts]=title,description

Response

200

application/vnd.api+json

List of podcasts

data · object[]

Show child attributes

links · object

Show child attributes

meta · object

Show child attributes