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

# List the agency's sub-accounts.

> Returns a paginated list of the agency's sub-account workspace cards, newest first. Supports an optional name search. The response has `data` (an array of cards) plus a `meta` block with current_page, last_page, per_page and total.



## OpenAPI

````yaml /api-reference/agency-openapi.json get /workspaces
openapi: 3.1.0
info:
  title: DMLY Agency API
  version: 1.0.0
  description: >-
    The DMLY Agency API lets a whitelabel reseller manage its sub-accounts

    programmatically — provision customer workspaces, assign plans and add-ons,
    and

    subscribe to sub-account lifecycle events. It is a separate surface from the

    public workspace [REST API](/api-reference/introduction): a different base
    URL, a

    different key, and a different set of webhooks.


    ## Base URL


    ```

    https://dash.dmly.io/api/agency/v1

    ```


    ## Authentication


    Every request carries an **agency API key**, which authenticates the acting
    agency

    and scopes every request to that agency's own sub-accounts — an agency can
    only

    ever see and act on its own workspaces.


    ```

    x-api-key: dmly_ag_xxxxxxxx…

    ```


    `Authorization: Bearer dmly_ag_xxxxxxxx…` is also accepted.


    Mint and revoke keys from the agency console under **API Keys**. The
    plaintext key

    is shown **once** on creation; only its hash is stored. An agency key is
    different

    from a workspace API key (`dmly_…`) and is not interchangeable with it.


    ## Conventions


    - Sub-accounts, plans, add-ons and webhook endpoints are identified by their
      public `uuid`, returned as `uuid`.
    - Lists are paginated with `?per_page` (alias `?limit`) — default 25, hard
    cap 100.


    ## Availability


    The whole surface can be disabled fleet-wide during an incident without
    revoking

    individual keys; while it is off, every endpoint returns `503`.
  contact:
    name: DMLY
    url: https://dmly.io
servers:
  - url: https://dash.dmly.io/api/agency/v1
    description: DMLY
security:
  - agencyApiKeyAuth: []
  - agencyBearerAuth: []
tags:
  - name: Agency Plans
    description: Endpoints for Agency Plans.
  - name: Agency Subscriptions and add-ons
    description: Endpoints for Agency Subscriptions and add-ons.
  - name: Agency Webhook endpoints
    description: Endpoints for Agency Webhook endpoints.
  - name: Agency Workspaces
    description: Endpoints for Agency Workspaces.
  - name: Agency events
    description: Sub-account lifecycle events DMLY posts to your endpoint.
paths:
  /workspaces:
    get:
      tags:
        - Agency Workspaces
      summary: List the agency's sub-accounts.
      description: >-
        Returns a paginated list of the agency's sub-account workspace cards,
        newest first. Supports an optional name search. The response has `data`
        (an array of cards) plus a `meta` block with current_page, last_page,
        per_page and total.
      operationId: workspaces.index.get
      parameters:
        - name: search
          in: query
          required: false
          description: Case-insensitive substring match on the workspace name.
          schema:
            type: string
          example: acme
        - name: per_page
          in: query
          required: false
          description: Items per page. Default 25, clamped to the 1-100 range.
          schema:
            type: integer
          example: 25
      responses:
        '200':
          description: A paginated list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/Unavailable'
components:
  schemas:
    PaginatedList:
      type: object
      description: A paginated collection. `per_page` defaults to 25 and is capped at 100.
      properties:
        data:
          type: array
          items:
            type: object
        links:
          type: object
          properties:
            first:
              type: string
              nullable: true
            last:
              type: string
              nullable: true
            prev:
              type: string
              nullable: true
            next:
              type: string
              nullable: true
        meta:
          type: object
          properties:
            current_page:
              type: integer
            from:
              type: integer
              nullable: true
            last_page:
              type: integer
            per_page:
              type: integer
            to:
              type: integer
              nullable: true
            total:
              type: integer
    Error:
      type: object
      properties:
        message:
          type: string
  responses:
    Unauthorized:
      description: The agency API key is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: This agency has been suspended, so its keys no longer work.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: >-
        Rate limit exceeded: 120 requests per minute per agency key. Requests
        without a valid key share a per-IP budget of 60 per minute instead.
      headers:
        Retry-After:
          description: Seconds until the limit resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unavailable:
      description: The reseller API is currently disabled fleet-wide.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    agencyApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your agency API key (`dmly_ag_…`). It authenticates the acting agency
        and scopes every request to that agency's own sub-accounts and plans.
    agencyBearerAuth:
      type: http
      scheme: bearer
      description: 'The same agency API key, sent as `Authorization: Bearer dmly_ag_…`.'

````