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

# List Banned Chat Users

> People banned from your stream's chat, newest first.

List the people banned from your stream's chat, newest ban first.

## Behavior

* Needs an API key with gallery access, like the gallery endpoints. Other keys get `403` with type `forbidden`. See [Authentication](https://docs.snipp.gg/authentication.md).
* Needs Plus or Ultra, like the other endpoints for your own stream; otherwise `403` with type `plan_required`.
* Paginated with `limit` and `cursor`. See [Pagination](https://docs.snipp.gg/concepts/pagination.md).
* Timeouts are not listed, only bans.

## Example

```bash theme={null}
curl "https://api.snipp.gg/live/bans?limit=20" \
  -H "api-key: YOUR_API_KEY"
```


## OpenAPI

````yaml api-reference/openapi.json GET /live/bans
openapi: 3.0.0
info:
  title: Snipp.gg API
  description: Image and video hosting API. Upload, manage, and share media files.
  version: 3.0.0
servers:
  - url: https://api.snipp.gg
    description: Default. Load-balanced across regions. No upload cap.
  - url: https://eu-west-1.api.snipp.gg
    description: EU West regional endpoint. Pins uploads and storage to EU West.
  - url: https://us-west-1.api.snipp.gg
    description: US West regional endpoint. Pins uploads and storage to US West.
  - url: https://flux.snipp.gg
    description: Alternative host. Capped at 100 MB per upload.
security:
  - apiKeyAuth: []
paths:
  /live/bans:
    get:
      summary: List Banned Chat Users
      description: People banned from your stream's chat, newest first.
      operationId: listLiveBans
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Cursor'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  bans:
                    type: array
                    items:
                      $ref: '#/components/schemas/LiveBan'
                  has_more:
                    type: boolean
                  next_cursor:
                    type: string
                    nullable: true
                required:
                  - bans
                  - has_more
                  - next_cursor
              example:
                bans:
                  - user:
                      id: '9876543210'
                      username: snipp
                      nickname: Snipp
                      avatar: https://cdn.snipp.gg/avatar.png
                      verified: true
                      plan: free
                    banned_at: '2026-11-06T08:15:00.000Z'
                has_more: false
                next_cursor: null
          headers:
            request-id:
              $ref: '#/components/headers/RequestId'
        '400':
          $ref: '#/components/responses/E400'
        '401':
          $ref: '#/components/responses/E401'
        '403':
          $ref: '#/components/responses/E403'
        '405':
          $ref: '#/components/responses/E405'
        '429':
          $ref: '#/components/responses/E429'
        '500':
          $ref: '#/components/responses/E500'
components:
  parameters:
    Limit:
      name: limit
      in: query
      required: false
      description: Items per page, 1 to 100.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 30
    Cursor:
      name: cursor
      in: query
      required: false
      description: '`next_cursor` from the previous page.'
      schema:
        type: string
  schemas:
    LiveBan:
      type: object
      description: Someone banned from your stream's chat.
      properties:
        user:
          $ref: '#/components/schemas/UserRef'
        banned_at:
          type: string
          format: date-time
      required:
        - user
        - banned_at
    UserRef:
      type: object
      properties:
        id:
          type: string
          description: User ID (snowflake).
        username:
          type: string
          nullable: true
        nickname:
          type: string
          nullable: true
        avatar:
          type: string
          description: Avatar URL. Falls back to `https://cdn.snipp.gg/avatar.png`.
        verified:
          type: boolean
        plan:
          $ref: '#/components/schemas/Plan'
      required:
        - id
        - username
        - nickname
        - avatar
        - verified
        - plan
      description: A user embedded inside another resource.
    Error:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
      required:
        - error
      description: Every non-2xx response has this body.
    Plan:
      type: string
      enum:
        - free
        - plus
        - ultra
    ErrorDetail:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ErrorType'
        message:
          type: string
          description: Human-readable sentence. Do not match on it; use `type`.
        username:
          type: string
          description: >-
            `suspended` on `GET /users/{id}` only: the suspended user's
            username.
        quota:
          type: integer
          description: '`quota_exceeded` only: weekly quota in bytes.'
        used:
          type: integer
          description: '`quota_exceeded` only: bytes used in the current window.'
        resets_at:
          type: string
          format: date-time
          description: '`quota_exceeded` only: when the weekly window resets.'
          nullable: true
        failed:
          type: array
          items:
            $ref: '#/components/schemas/FailedFile'
          description: '`upload_failed` only: one entry per file.'
        expires_at:
          type: string
          format: date-time
          description: '`timed_out` only: when the timeout ends.'
        retry_at:
          type: string
          format: date-time
          description: '`slow_mode` only: when you can send your next message.'
        missing:
          type: array
          items:
            type: integer
          description: >-
            `Missing chunks.` on the last piece of a chunked upload only:
            zero-based indexes of the pieces the server does not have. Send
            them, then the last piece again.
      required:
        - type
        - message
    ErrorType:
      type: string
      enum:
        - invalid_request
        - unauthorized
        - forbidden
        - suspended
        - blocked
        - moderated
        - plan_required
        - timed_out
        - banned
        - chat_off
        - slow_mode
        - not_found
        - method_not_allowed
        - file_too_large
        - unsupported_type
        - quota_exceeded
        - rate_limited
        - upload_failed
        - internal
        - unavailable
      description: Machine-readable error category. See [Errors](/concepts/errors).
    FailedFile:
      type: object
      properties:
        index:
          type: integer
          description: Zero-based position of the file in the request.
        error:
          $ref: '#/components/schemas/ErrorDetail'
      required:
        - index
        - error
      description: >-
        A file that was not stored. `error` has the same shape as a top-level
        error.
  headers:
    RequestId:
      description: Unique ID for the request. Include it when contacting support.
      schema:
        type: string
        format: uuid
  responses:
    E400:
      description: Invalid request
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E401:
      description: Missing or invalid key
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E403:
      description: Not allowed
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E405:
      description: Method not allowed
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
        Allow:
          description: Methods this path accepts.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E429:
      description: Rate limited
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E500:
      description: Internal error
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: api-key
      description: Your API key from an app on snipp.gg/settings/apps

````

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