Skip to content

Support for List Query Parameters in GET List Requests

Starting from version 3.3, our scripts support query parameters for GET requests. This allows you to filter, select, sort, limit and skip the results directly from the URL.

These parameters can be used with:

  • /api/shows
  • /api/profiles
  • /api/pages
  • /api/playlists etc.

Supported Query Parameters

Parameter Description Example
filter Filters the results based on field values.
Use the format: key:value.
Multiple filters are comma-separated.
Supports string and regex filters.		 filter=name:Test,path=/^STUDIO1/i
select Specifies which fields to return. Separate multiple fields with commas. select=name,enabled
sort Sorts the results by a field. Use :1 for ascending, :-1 for descending. sort=name:1
limit Limits the number of returned results. limit=1
skip Skips N results. skip=10

Examples

  • Get one show with the name TestShowName sorted by name, returning only the name field:
    GET /api/shows?filter=name:TestShowName&select=name&sort=name:1&limit=1

  • Get all shows with name TestShowName and path starting with STUDIO1, sorted by name:
    GET /api/shows?filter=name:TestShowName,path=/^STUDIO1/i&sort=name:1

  • Get only the name and enabled fields of all shows:
    GET /api/shows?select=name,enabled