Returns a list of media groups

GET /api/media/mediagroup

Query parameters

  • name string

    Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE

  • token string

    Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE

  • publicTitle string

    Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE

  • groupType string

    Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE

  • slugIdentifier string

    Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE

  • created string

    Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE

  • updated string

    Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE

  • order integer

    Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE

  • itemOfTheDay boolean

    This property is used to mark an entity as the item of the day. | Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE

  • id integer

    Requires access right: SCOPE

  • archived boolean

    Requires access right: SCOPE

  • addonData_shopify_product_id string

    Requires access right: SCOPE

  • addonData_vimeo_id string

    Requires access right: SCOPE

  • searchString string

    text to search for in the list

  • orderFieldName string

    name of the order field

  • orderFieldSort string

    sorting mode

    Values are DESC or ASC.

  • page integer

    page of the list

    Default value is 0.

  • pageSize integer

    number of entries for each page

    Minimum value is 1, maximum value is 200. Default value is 50.

  • withMaxPageNumber string

    returns the number of pages available as a header if this is set

  • iw-build-id string

    build id of the client

  • iw-package-id string

    package id of the client

Responses

  • 200 application/json

    Returns a list of media groups

    Hide response attributes Show response attributes object
    • id integer
    • group_type string
    • token string
    • public_title string
    • public_language_code string
    • public_subtitle string
    • public_author string
    • public_summary string
    • public_description string
    • public_owner_name string
    • public_owner_mail string
    • public_explicit boolean
    • public_thumbnail string
    • public_keywords string
    • public_category string
    • public_itunes_type string
    • public_guid string
    • created string(date-time)
    • updated string(date-time)
    • unified_cat_ids object

      Additional properties are allowed.

    • unified_cat_names object

      Additional properties are allowed.

    • slug_identifier string
    • order integer
    • item_of_the_day boolean
GET /api/media/mediagroup
curl \
 --request GET 'https://replace-with-own-host.iw-erp.de/api/media/mediagroup' \
 --header "x-session-token: $API_KEY"
Response examples (200)
[
  {
    "id": 42,
    "group_type": "string",
    "token": "string",
    "public_title": "string",
    "public_link": "string",
    "public_link_rss": "string",
    "public_copyright": "string",
    "public_language_code": "string",
    "public_subtitle": "string",
    "public_author": "string",
    "public_summary": "string",
    "public_description": "string",
    "public_owner_name": "string",
    "public_owner_mail": "string",
    "public_explicit": true,
    "public_thumbnail": "string",
    "public_keywords": "string",
    "public_category": "string",
    "public_itunes_type": "string",
    "public_guid": "string",
    "created": "2025-05-04T09:42:00Z",
    "updated": "2025-05-04T09:42:00Z",
    "unified_cat_ids": {},
    "unified_cat_names": {},
    "slug_identifier": "string",
    "order": 42,
    "item_of_the_day": true
  }
]