v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB

series

List series

get/v2/sites/{site_id}/series/

Path parameters

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

Query parameters

qstring

Allows for querying results

Series can be queried by the following attributes:

custom_params
description
id
title

Example: id:+abcd1234

sortstring

Allows for sorting results

Sort order can be one of asc, dsc

Series can be sorted by the following attributes:

created
title

Example: sort=created:dsc

Response

Resources successfully retrieved

pageinteger

Offset for returned resources

page_lengthinteger

Maximum number of resources to return

totalinteger

Number of resources available before pagination

Example response

{
  "page": 1,
  "page_length": 10,
  "total": 1,
  "series": [
    {
      "schema": "https://schema.jwplayer.com/types/thumbnail.json",
      "id": "Ny05CEfj",
      "created": "2019-09-25T15:29:11.042095+00:00",
      "last_modified": "2019-09-25T15:29:11.042095+00:00",
      "relationships": {
        "media": [
          {
            "id": "Ny05CEfj"
          }
        ]
      }
    }
  ]
}