layouts

List layouts

List the workspace's multi-zone layouts, including each layout's name, resolution, and zone count.

get/v1/layouts

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/layouts
  • 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, the number of matching rows.

usableAtstring

Location id: only rows usable at that location (homed there, at the workspace root, or shared to it).

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

Changes

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