Querying the API

PostgREST-style filtering, embedding related records with select, and getting your own content back out.

Updated

Copy page
View as Markdown View this page as plain text Open in Claude Ask questions about this page Open in ChatGPT Ask questions about this page

The API is built on PostgREST, which is worth knowing because it explains the query syntax: you filter, select, and embed with query parameters rather than through one endpoint per question.

If you have not made a request yet, Get started goes from a token to content on a screen in five of them.

Authenticating

Send your API token in the Authorization header, prefixed with Token.

curl -H "Authorization: Token $API_TOKEN" \
     https://api.screenlyapp.com/api/v4.1/assets

The examples below drop the host and write paths as /v4.1/....

Filtering

Comparisons go in the query string, as field=operator.value.

# every video
GET /v4.1/assets?type=eq.video

select decides which columns come back, and pulls in related tables in the same request.

# playlists, each with its items
GET /v4.1/playlists?select=*,playlist_items(*)

That is usually the difference between one request and a hundred: ask for the nested data rather than looping over ids.

Getting your content out

Every asset carries a source_url. Listing your assets and fetching each source_url is how you export a library.

The full reference

Endpoint by endpoint, with schemas, in the v4.1 API reference.

Was this page helpful?

Thanks. Glad it helped.

Thanks. That tells us where to look next.

Contact support

Type to search the documentation