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

# Listar workspaces do usuário

> Autenticação por **sessão** (`sessionToken` JWT de login), não API key de mensageria. Retorna todos os workspaces da conta com `role` (OWNER, ADMIN, MEMBER). `include=billing` adiciona snapshot de plano/saldo (exige `billing:read` na rota v1).



## OpenAPI

````yaml /es/platform-api/api-reference/openapi-platform.json get /v1/platform/workspaces
openapi: 3.0.3
info:
  title: Notifique API Platform
  description: >-
    Conta, billing, API keys, equipe e tudo que o painel faz — via API. Rotas
    públicas: `register`, `verify`, `login`. Autentique o restante com
    `Authorization: Bearer sk_live_...` ou `x-api-key`. Escopos: `api_keys:*`,
    `billing:*`, `workspace:members:*` conforme a rota.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Produção
security:
  - ntfPlatformBearerAuth: []
  - ntfPlatformApiKeyHeader: []
tags:
  - name: 'Platform: Conta'
    description: Registro, verificação de telefone e login.
  - name: 'Platform: Billing'
    description: >-
      Assinatura, saldo, recarga e histórico de uso de créditos (`billing:read`
      / `billing:manage`).
  - name: 'Platform: API Keys'
    description: Gestão de chaves do workspace (`api_keys:read` / `api_keys:manage`).
  - name: 'Platform: Workspace'
    description: Listagem de workspaces (sessão) e recursos por workspace.
  - name: 'Platform: Equipe'
    description: >-
      Membros e convites (`workspace:members:read` /
      `workspace:members:manage`).
  - name: Sandbox
    description: Mensajes de prueba interceptados en el entorno sandbox.
paths:
  /v1/platform/workspaces:
    get:
      tags:
        - 'Platform: Workspaces'
      summary: Listar workspaces do usuário
      description: >-
        Autenticação por **sessão** (`sessionToken` JWT de login), não API key
        de mensageria. Retorna todos os workspaces da conta com `role` (OWNER,
        ADMIN, MEMBER). `include=billing` adiciona snapshot de plano/saldo
        (exige `billing:read` na rota v1).
      operationId: ntfPlatform_listUserWorkspaces
      parameters:
        - name: include
          in: query
          schema:
            type: string
            enum:
              - billing
          description: Inclui dados de billing quando `billing`.
      responses:
        '200':
          description: Lista de workspaces.
          content:
            application/json:
              example:
                success: true
                data:
                  - role: OWNER
                    id: clws_01H...
                    name: Produção BR
                    slug: producao-br
                    color: '#10B981'
              schema:
                $ref: '#/components/schemas/ntfPlatform_ListUserWorkspacesResponse'
        '401':
          $ref: '#/components/responses/NtfPlatform_Unauthorized'
        '403':
          description: SESSION_REQUIRED com API key.
          content:
            application/json:
              example:
                success: false
                code: SESSION_REQUIRED
      security:
        - ntfPlatformBearerAuth: []
components:
  schemas:
    ntfPlatform_ListUserWorkspacesResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: array
          items:
            type: object
            properties:
              role:
                type: string
              id:
                type: string
              name:
                type: string
              slug:
                type: string
              color:
                type: string
      example:
        success: true
        data:
          - role: string
            id: clxx...
            name: Exemplo
            slug: string
            color: string
    NtfPlatform_Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
        code:
          type: string
        message:
          type: string
          example: Campo inválido ou ausente.
        retryAfter:
          type: integer
          example: 60
      example:
        success: false
        error: string
        code: string
  responses:
    NtfPlatform_Unauthorized:
      description: Credenciais ou token inválidos.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NtfPlatform_Error'
          example:
            success: false
            code: VERIFICATION_TOKEN_INVALID
  securitySchemes:
    ntfPlatformBearerAuth:
      type: http
      scheme: bearer
      description: API key (`sk_live_...`) ou `sessionToken` de login.
    ntfPlatformApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: Alternativa ao Bearer.

````