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

# Whether a username or org name is free



## OpenAPI

````yaml /api-reference/openapi.json get /names/{name}
openapi: 3.1.0
info:
  title: Patch API
  version: 1.0.0
  description: >-
    The public API behind patch.gg, the desktop app and pch. Changes within v1
    are additive only. Errors are { error: { code, message, details } }; branch
    on code.
servers:
  - url: https://patch.gg/api/v1
security: []
paths:
  /names/{name}:
    get:
      tags:
        - Account
      summary: Whether a username or org name is free
      parameters:
        - schema:
            type: string
          required: true
          name: name
          in: path
      responses:
        '200':
          description: The name's status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NameStatus'
components:
  schemas:
    NameStatus:
      type: object
      properties:
        name:
          type: string
        status:
          type: string
          enum:
            - available
            - taken
            - reserved
            - retired
            - invalid
      required:
        - name
        - status

````

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