Hot Mic Users API

openapi: 3.2.0
info:
  title: Hot Mic Users API
  version: '2026-10-12'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-12: 13 operation(s) read from 5 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Hot Mic has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 4
    documentation: 9
    pages-with-code: 3
    pages-read: 5
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-12'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://hotmic.io/docs/api
  - https://hotmic.io/docs/api/index
  - https://hotmic.io/docs/api/show-series
  - https://hotmic.io/docs/sdks/ios/headless
  - https://hotmic.io/docs/sdks/javascript/headless
servers:
- url: https://public-api.hotmic.io
security:
- apiKey: []
tags:
- name: Users
paths:
  /users:
    get:
      operationId: get_users
      tags:
      - Users
      summary: Get All Users
      description: Get a user by its ID.
      x-source: https://hotmic.io/docs/api
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Limits the number of results returned by the query. Defaults to 100.
      - name: ids
        in: query
        required: false
        schema:
          type: string
        description: Filter results to only include 1 or more users by id. Separate multiple ids with an underscore.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUsersResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_users
      tags:
      - Users
      summary: Create User
      description: Creates a new user.
      x-source: https://hotmic.io/docs/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostUsersRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostUsersResponse'
      x-evidence:
        kind: documentation
  /users/{id}:
    put:
      operationId: put_users_id
      tags:
      - Users
      summary: Update a User
      description: Update user information, such as their name or the default invite link for their profile.
      x-source: https://hotmic.io/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutUsersIdRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutUsersIdResponse'
      x-evidence:
        kind: documentation
    get:
      operationId: get_users_id
      tags:
      - Users
      summary: GET /users/{id}
      x-source: https://hotmic.io/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUsersIdResponse'
      x-evidence:
        kind: code-example
        language: ruby
        snippet: URI ( "https://public-api.hotmic.io/users/:id"
components:
  schemas:
    GetUsersIdResponse:
      type: object
      properties:
        _id:
          type: string
        name:
          type: string
        email:
          type: string
        default_invite_link:
          type: string
    PostUsersResponse:
      type: object
      properties:
        name:
          type: string
          description: User name
    GetUsersResponse:
      type: object
      properties:
        name:
          type: string
          description: User name
    PostUsersRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the user
        email:
          type: string
          description: The email of the user
        default_invite_link:
          type: string
          description: The default invite link of the user
        display_name:
          type: string
          description: The display name, such as "superfan"
        profile_pic:
          type: string
          description: A URL to show for the user as a profile picture
        tags:
          type: array
          description: General tags associated with the user
        authorized_stream_tags:
          type: array
          description: Tags a user can add to a stream
      required:
      - name
    PutUsersIdResponse:
      type: object
      properties:
        _id:
          type: string
          description: User ID
        name:
          type: string
          description: User name
        email:
          type: string
          description: User email
        default_invite_link:
          type: string
          description: Default invite link
    PutUsersIdRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the user to modify
        email:
          type: string
          description: The email of the user to modify
        default_invite_link:
          type: string
          description: The default_invite_link of the user to modify
        tags:
          type: array
          description: General tags associated with the user
        authorized_stream_tags:
          type: array
          description: Tags a user can add to a stream
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key