---
title: "App Config"
method: GET
path: "/apps/configs/{config_id}.json"
tags: ["App Config"]
---

# App Config

`GET /apps/configs/{config_id}.json`

## Request

- Base URL: `https://cdn.jwplayer.com`
- URL: `https://cdn.jwplayer.com/apps/configs/{config_id}.json`
- Auth: none declared

Get config JSON object for an App Config

## Path parameters

- `config_id` string, string, required

## Response `200`

A JSON object describing an App Config object.

- object
  - `ad_schedule` string: Eight-character, alphanumeric ID of an ad schedule
  - `analytics_token` string: Unique ID for analytics associated with a site
  - `assets` AppConfigAssetsObj: External resources to use with the app
    - `banner` string: Valid URL of a hosted image to be used as the app logo in the header E.g.: `https://example.com/images/your_awesome_logo.png` **NOTE**: Does this need to be replaced by the following? ``` "assets": { "banner": "https://www.jwpapp.com/v/showcase/defaults/images/logo.png" } ``` Leave blank to use the default image.
  - `content` AppConfigContentObj[]: List of playlists that populate the shelves on the app home page
    - `background_color` string: Valid [hex triplet](https://en.wikipedia.org/wiki/Web_colors#Hex_triplet) theme background color, such as `#F00` or `#FF0000` Leaving this parameter blank maintains the original theme background color.
    - `content_id` string: Eight-character, alphanumeric ID of the content to use - Needed for - `playlist` - Not needed for - `continue_watching` - `favorites`
    - `enable_text` boolean: Controls if the title and description text overlays appear on the poster images
    - `featured` boolean: Enables prominently displaying featured content
    - `title` string: Title for the row of content in the app This value will overwrite the feed title, if available.
    - `type` 'continue_watching' | 'favorites' | 'playlist', required: Type of content
  - `custom` object: Use this object to set custom properties
  - `description` string: Short description of the type of content in the App Config This description is used for SEO.
  - `features` AppConfigFeaturesObj: Object containing all sitewide OTT settings
    - `enable_casting` boolean: Controls the ability to cast videos from the OTT app
    - `enable_sharing` boolean: Controls if the **Share** button appears on the video and series detail screens
    - `continue_watching_list` string: Eight-character, alphanumeric ID of a continue watching watchlist
    - `favorites_list` string: Eight-character, alphanumeric ID of a favorites watchlist
    - `recommendations_playlist` string: Eight-character, alphanumeric ID of a recommendations feed
    - `search_playlist` string: Eight-character, alphanumeric ID of a search feed
  - `integrations` AppConfigIntegrationsObj: Settings of supported integrations.
    - `cleeng` object
      - `id` string, string: ID of the Cleeng ID environment to use as a backend for account, subscription, and checkout functionality Omit this key to disable Cleeng and the related functionality.
      - `monthly_offer` string, string: Offer ID for a monthly subscription through Cleeng When both `cleeng.id` and `cleeng.monthly_offer` are defined, the payments and subscription functionality is displayed in the OTT app. The offer ID maps to a configured offer in the Cleeng environment that represents a monthly subscription. The OTT app only uses the price, free days, and free period information from the Cleeng offer. Additionally, the OTT app does not verify the offer length. **NOTE**: If `cleeng.id` is defined but neither `cleeng.monthly_offer` nor `cleeng.yearly_offer` is defined, the payments and subscription functionality is not displayed in the OTT app.
      - `yearly_offer` string, string: Offer ID for a yearly subscription through Cleeng When both `cleeng.id` and `cleeng.yearly_offer` are defined, the payments and subscription functionality is displayed in the OTT app. The offer ID maps to a configured offer in the Cleeng environment that represents a yearly subscription. The OTT app only uses the price, free days, and free period information from the Cleeng offer. Additionally, the OTT app does not verify the offer length. **NOTE**: If `cleeng.id` is defined but neither `cleeng.yearly_offer` nor `cleeng.monthly_offer` is defined, the payments and subscription functionality is not displayed in the OTT app.
      - `use_sandbox` boolean: Enables using the Cleeng mediastore sandbox URL **Possible values**: * `false`: The Cleeng production URL is used (https://mediastore.cleeng.com). * `true`: The Cleeng sandbox URL is used (https://mediastore-sandbox.cleeng.com). If either this parameter or `cleeng.id` is not defined, this setting is ignored.
  - `menu` AppConfigMenuObj[]
    - `content_id` string, required: Eight-character, alphanumeric ID of the feed to use for the menu page
    - `label` string, required: Text displayed for the menu item
    - `filter_tags` string: Comma-separated list of tags by which to filter the playlist defined by `playlist_id`
    - `type` 'playlist', required: Type of content
  - `player` string: Eight-character, alphanumeric player ID to use with the App Config
  - `site_name` string: Title displayed in the `<title>` tag of the App Config
  - `styling` AppConfigStylingObj: Settings for styling the OTT app
    - `background_color` string: Color of the theme's background This must be a valid [hex triplet](https://en.wikipedia.org/wiki/Web_colors#Hex_triplet) value. Example: `#F00` or `#FF0000` Omitting this value maintains the default color of the theme's background.
    - `dynamic_blur` boolean: Determines if the background of the app matches the image that is currently in focus **Possible values**: * `true`: The dynamic blur feature is enabled. When a user hovers a card, the blurred image changes to the selected item. * `false`: The dynamic blur feature is disabled.
    - `footer_text` string: Short text placed in the footer of the app This can be used to add copyright text.
    - `header_background` string: Background color of the header This must be a valid HEX color. Example: `#1a1a1a` Omitting this value makes the background header transparent.
    - `highlight_color` string: Color used for UI elements, such as progress spinner, buttons, and other call out items The must be a valid [hex triplet](https://en.wikipedia.org/wiki/Web_colors#Hex_triplet) value. Example: `#F00` or `#FF0000`. Omitting this value maintains the default color.
    - `poster_fading` boolean: Set this parameter to `true` if you want to enable the Poster Fading feature. By default, a boxed preview is shown on the video and series detail page. With posterFading set to `true`, this image is placed on the background instead and fills a larger portion of the screen.
    - `shelf_titles` boolean: Determines if titles are displayed below the cards (poster images) on the home, playlist and search screens **Possible values**: * `true`: Title are displayed below the cards. * `false`: Titles are not display below the cards. Use this option if the cards contain titles as part of the imagery.

## Other responses

- `404`: Not Found The requested asset could not be found.

---

[API](https://skmtc.dev/jwplayer/apis/delivery-api.md) - [All operations](https://skmtc.dev/jwplayer/apis/delivery-api/llms.txt) - [OpenAPI document](https://skmtc.dev/jwplayer/apis/delivery-api/revisions/a37fd1dde168?raw)