> ## Documentation Index
> Fetch the complete documentation index at: https://docs.layarva.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GET /groups

> Workspace-owned resources only. No unsupported query parameters on details or writes. Required permissions: library.read. Use Postman or your backend. Keep your API key private; do not enter it in this public documentation page.

Required permissions: `library.read`.

Read request; no mutation Idempotency-Key is required.

> [!NOTE]
>
> Use your Platform API key in Postman or your backend. Keep it private; do not enter it in this public page. Your workspace permissions and plan limits apply.

See the [quickstart](https://docs.layarva.com/developers/platform-quickstart.md) for request examples. Required fields and responses are listed below.


## OpenAPI

````yaml api/platform-workspace.openapi.json GET /groups
openapi: 3.1.0
info:
  title: Layarva Platform / Workspace API
  version: 1.1.0
  description: >-
    Manage Library, Playlists, Channels, Locations, Edges, Screens and
    Schedules. Use a Platform key, not a Widget key. See
    https://docs.layarva.com/developers/platform-quickstart. Upload supported
    files, export eligible offline packages and receive signed Platform
    webhooks. Permissions, plan limits and publishing rules apply. If a request
    returns 503, stop that workflow and contact support with its requestId.
servers:
  - url: https://api.layarva.com/api/platform/v1/workspaces/{workspaceId}
    variables:
      workspaceId:
        default: workspace_example
security:
  - PlatformBearer: []
paths:
  /groups:
    get:
      tags:
        - groups
      summary: GET /groups
      description: >-
        Workspace-owned resources only. No unsupported query parameters on
        details or writes. Required permissions: library.read. Use Postman or
        your backend. Keep your API key private; do not enter it in this public
        documentation page.
      operationId: get__groups
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
          description: Default 50; 1–100 decimal string; repeat/unknown parameters refused.
        - name: after
          in: query
          schema:
            type: string
            pattern: ^[A-Za-z0-9_-]{1,100}$
          description: >-
            Opaque prior nextCursor; ID-ascending keyset pagination, not a
            timestamp.
        - name: q
          in: query
          schema:
            type: string
            maxLength: 100
        - name: id
          in: query
          schema:
            type: string
            pattern: ^[A-Za-z0-9_-]{1,100}$
        - name: libraryType
          in: query
          schema:
            type: string
            enum:
              - MEDIA
              - IMAGE
              - VIDEO
              - AUDIO
              - BACKGROUND
              - LOTTIE
              - DOCUMENTS
      responses:
        '200':
          description: Safe live-authorized result
          headers:
            X-Request-Id:
              schema:
                type: string
            Cache-Control:
              schema:
                const: private, no-store
            X-RateLimit-Limit:
              schema:
                type: string
            X-RateLimit-Remaining:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Group'
                  page:
                    $ref: '#/components/schemas/Page'
                required:
                  - data
                  - page
                additionalProperties: false
        default:
          description: >-
            Error with code, message and requestId. Follow Retry-After when
            present. Contact support with the requestId if the problem
            continues.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            X-Request-Id:
              schema:
                type: string
            Retry-After:
              schema:
                type: string
components:
  schemas:
    Group:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        libraryType:
          type: string
        createdAt:
          type: string
          format: date-time
      required:
        - id
        - name
        - libraryType
        - createdAt
      additionalProperties: false
    Page:
      type: object
      properties:
        limit:
          type: integer
          minimum: 1
          maximum: 100
        nextCursor:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - limit
        - nextCursor
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            requestId:
              type: string
          required:
            - code
            - message
            - requestId
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    PlatformBearer:
      type: http
      scheme: bearer
      bearerFormat: lv_platform_<43 base64url characters>
      description: >-
        Platform API key for one workspace. Create it in Settings with an expiry
        date or Never expire. Keep it private; use it from Postman or your
        backend, not browser code. Widget keys are not accepted.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.