media

List media

Return the media library: images, videos, PDFs, presentations, fonts, web links, and app-backed assets. Use limit and cursor to page through results, count=1 to include a total count, search to search by name or tag, and the comma-separated kind, state, and folderId parameters to filter. Paging is optional but recommended, since a library can hold thousands of items.

Without limit, every visible asset comes back unordered and without nextCursor. With limit, rows are newest first.

get/v1/media

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/media
  • Auth: HTTP bearer

Query parameters

searchstring

Case-insensitive match on name or tags.

kindstring

Comma-separated kinds, e.g. image,video.

statestring

Comma-separated processing states.

folderIdstring

Comma-separated folder ids.

usableAtstring

Location id: only assets that may play there (own, root library, or shared in).

limitinteger

Page size (max 500). Omit to get every row.

cursorstring

The nextCursor of the previous page.

count'1'

With limit: also return total.

Response

Success.

nextCursorstring nullable

Present when ?limit was passed. Send it back as ?cursor= for the next page; null on the last page.

totalinteger

Total matching rows, when the route computes it.

Example response

{
  "data": [
    {
      "id": "med_0c1d2e3f4a5b6c7d"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.