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

# List user snapshots

> Returns the list of user-level snapshots visible to the caller. Superadmins see all snapshots; admins see snapshots assigned to their organization or marked as global.



## OpenAPI

````yaml /api-reference/openapi.yaml get /api/user-snapshots
openapi: 3.0.3
info:
  title: Tether Relay and Tether API
  version: 1.0.0
  description: >-
    Route-derived OpenAPI contract generated from tether-relay backend sources.
    Regenerate with scripts/sync-openapi-from-backend.mjs.
servers:
  - url: https://your-instance.example.com
    description: Production
  - url: http://localhost:2212
    description: Local API service
security: []
tags:
  - name: AI
  - name: Applications
  - name: Approval
  - name: Auth
  - name: Automations
  - name: Calls
  - name: Campaigns
  - name: Contact Analytics
  - name: Contact Metrics
  - name: Contact Notes
  - name: Contacts
  - name: Conversation Monitor
  - name: Conversations
  - name: Departments
  - name: Email
  - name: Escalation Dashboard
  - name: Event Logs
  - name: Google Sheets
  - name: Marketplace
  - name: Messages
  - name: Notification Sounds
  - name: Notifications
  - name: Org Snapshots
  - name: Organizations
  - name: Outreach
  - name: Outreach Metrics
  - name: Outreach Sources
  - name: Pipelines
  - name: Processes
  - name: Prompts
  - name: Reminders
  - name: Sms
  - name: Templates
  - name: Traces
  - name: Training
  - name: Upload
  - name: User Snapshots
  - name: Users
  - name: Vertical
  - name: Webchats
  - name: Webhook
paths:
  /api/user-snapshots:
    get:
      tags:
        - User Snapshots
      summary: List user snapshots
      description: >-
        Returns the list of user-level snapshots visible to the caller.
        Superadmins see all snapshots; admins see snapshots assigned to their
        organization or marked as global.
      operationId: get_user_snapshots
      responses:
        '200':
          description: Snapshots returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSnapshotListResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSnapshotErrorResponse'
        '403':
          description: Forbidden – admin or superadmin role required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSnapshotErrorResponse'
        '500':
          description: Failed to retrieve snapshots
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSnapshotErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    UserSnapshotListResponse:
      type: object
      properties:
        snapshots:
          type: array
          items:
            $ref: '#/components/schemas/UserSnapshotSummary'
      required:
        - snapshots
      additionalProperties: true
      example:
        snapshots:
          - _id: 665f1a0c0e0a4b001a2c9f80
            name: Top performer baseline 2026-05
            sourceOrgName: Acme Corp
            sourceUserEmail: alex@acme.example
            counts:
              automations: 5
              prompts: 8
              templates: 12
            isGlobal: false
    UserSnapshotErrorResponse:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        details: {}
      additionalProperties: true
      example:
        error: Snapshot not found
        message: No snapshot exists with the given id
    UserSnapshotSummary:
      type: object
      properties:
        _id:
          type: string
        name:
          type: string
        description:
          type: string
          nullable: true
        sourceOrgId:
          type: string
          nullable: true
        sourceOrgName:
          type: string
          nullable: true
        sourceUserEmail:
          type: string
          nullable: true
        sourceUserName:
          type: string
          nullable: true
        counts:
          $ref: '#/components/schemas/UserSnapshotCounts'
        createdBy:
          type: string
          nullable: true
        createdByName:
          type: string
          nullable: true
        createdByRole:
          type: string
          nullable: true
        isGlobal:
          type: boolean
        assignedOrgIds:
          type: array
          items:
            type: string
        createdAt:
          type: string
          format: date-time
          nullable: true
        updatedAt:
          type: string
          format: date-time
          nullable: true
      additionalProperties: true
      example:
        _id: 665f1a0c0e0a4b001a2c9f80
        name: Top performer baseline 2026-05
        description: Senior AE automations and prompts for Q2 rollout.
        sourceOrgId: 64ee9a8b1e7f2a0011223344
        sourceOrgName: Acme Corp
        sourceUserEmail: alex@acme.example
        sourceUserName: Alex Rep
        counts:
          automations: 5
          prompts: 8
          templates: 12
        createdBy: 64ee9a8b1e7f2a001122339b
        createdByName: Pat Admin
        createdByRole: ADMIN
        isGlobal: false
        assignedOrgIds:
          - 64ee9a8b1e7f2a0011223344
        createdAt: '2026-05-15T09:00:00.000Z'
        updatedAt: '2026-05-15T09:00:00.000Z'
    UserSnapshotCounts:
      type: object
      properties:
        automations:
          type: integer
        prompts:
          type: integer
        templates:
          type: integer
      additionalProperties: true
      example:
        automations: 5
        prompts: 8
        templates: 12
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````