AviatoAviato
DeveloperAPI ReferenceLibrariesIdItems

/api/libraries/{id}/items

GET
/api/libraries/{id}/items

Path Parameters

id*string

Resource ID

Query Parameters

limit?integer

Max items to return

Range0 < value
offset?|

Number of items to skip

Range0 <= value
sortBy?string

Field to sort by (title, addedAt, updatedAt, year, releaseDate, rating, duration, certification)

sortOrder?string

Sort direction

Value in"asc" | "desc"
status?string

Filter by status

certification?string

Comma-separated list of certification codes to include (e.g. "G,PG,PG-13")

ignoreArticles?string

Ignore leading "a"/"an"/"the" when sorting by title

Value in"true" | "false"
numbersFirst?string

Sort items whose title begins with a digit before alphabetical entries

Value in"true" | "false"
includeLetterOffsets?string

Include letter→offset map for the alphabet jump-bar (only meaningful when sortBy=title)

Value in"true" | "false"
includeAvailableCertifications?string

Include the distinct certification codes present in the library

Value in"true" | "false"
includeEntities?string

Include linked entities (show, season, etc.) on each item

Value in"true" | "false"
group?string

Aggregate items by primary entity (show/album/etc.). When true, response shape switches to { slots: [...] }; ignores offset, letterOffsets, availableCertifications.

Value in"true" | "false"

Response Body

application/json

application/json

curl -X GET "https://example.com/api/libraries/string/items"
{
  "items": [
    {
      "id": "string",
      "libraryId": "string",
      "title": "string",
      "metadata": {
        "property1": null,
        "property2": null
      },
      "certification": "string",
      "status": "active",
      "addedAt": "string",
      "updatedAt": "string",
      "files": [
        {
          "id": "string",
          "libraryId": "string",
          "uri": "string",
          "filename": "string",
          "extension": "string",
          "fileInfo": {
            "property1": null,
            "property2": null
          },
          "mimeType": "string",
          "type": "media",
          "classification": "string",
          "itemId": "string",
          "status": "active",
          "edition": "string",
          "partNumber": 0,
          "size": 0,
          "duration": 0,
          "createdAt": "string",
          "updatedAt": "string",
          "assets": {
            "property1": "string",
            "property2": "string"
          },
          "assetAspects": {
            "property1": "string",
            "property2": "string"
          },
          "mediaKind": "video",
          "chapters": [
            {
              "id": "string",
              "fileId": "string",
              "startTime": 0,
              "endTime": 0,
              "role": "intro",
              "title": "string",
              "source": "string",
              "metadata": {
                "property1": null,
                "property2": null
              },
              "createdAt": "string",
              "updatedAt": "string",
              "assets": {
                "property1": "string",
                "property2": "string"
              }
            }
          ]
        }
      ],
      "assets": {
        "property1": "string",
        "property2": "string"
      },
      "assetAspects": {
        "property1": "string",
        "property2": "string"
      },
      "linkedEntities": [
        {
          "id": "string",
          "type": "string",
          "name": "string",
          "role": "string",
          "sortOrder": 0,
          "linkMetadata": {
            "property1": null,
            "property2": null
          },
          "assets": {
            "property1": "string",
            "property2": "string"
          },
          "assetAspects": {
            "property1": "string",
            "property2": "string"
          }
        }
      ],
      "playback": {
        "completed": true,
        "position": 0,
        "duration": 0
      }
    }
  ],
  "total": 0,
  "limit": 0,
  "offset": 0,
  "letterOffsets": {
    "property1": 0,
    "property2": 0
  },
  "availableCertifications": [
    "string"
  ]
}
{
  "error": "string"
}

/api/libraries/{id}/entities

Previous Page

/api/libraries/{id}/pipeline-plugins

Next Page