media-folders

List media folders

Return the media library's folder tree for this workspace, including each folder's id, name, parent folder, and location.

get/v1/media-folders

Request

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

Query parameters

limitinteger

Page size. Omit to get every row; pass it to page by cursor.

cursorstring

The nextCursor of the previous page.

count'1'

With limit: also return total.

usableAtstring

Location id: only folders usable at that location.

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": "fold_2b3c4d5e6f7a8b9c"
    }
  ]
}

Changes

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