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

# List Shorten Domains

> List all available domains for URL shortening.

### Params: Visibiliy

available options are

* `public` domains provided by the system and available for all users to use.
* `private` your custom domains that you have created and can only be used by you.
* `all` all domains that you can use.

You can fetch the available domains for shortening, including your own custom domains.


## OpenAPI

````yaml GET /shorten-domains
openapi: 3.0.1
info:
  title: U301 OpenAPI
  description: >-
    A sample API that uses a plant store as an example to demonstrate features
    in the OpenAPI specification
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.u301.com/v2
security: []
paths:
  /shorten-domains:
    get:
      tags: []
      summary: List Available Domains
      parameters:
        - name: perPage
          in: query
          description: 'Results per Page, range: 1-500'
          required: false
          example: '10'
          schema:
            type: integer
        - name: page
          in: query
          description: Current Page
          required: false
          example: '1'
          schema:
            type: integer
        - name: visibility
          in: query
          description: Domain Types
          required: false
          example: '1'
          schema:
            type: string
            enum:
              - public
              - private
              - all
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDomainList'
              examples:
                '1':
                  summary: Success
                  value:
                    meta:
                      total: 6
                      perPage: 10
                      currentPage: 1
                      lastPage: 1
                      firstPage: 1
                    data:
                      - domainName: x.jarfire.org
                        visibility: private
                      - domainName: go.jarfire.org
                        visibility: private
                      - domainName: t.fbi.com
                        visibility: public
                      - domainName: az.jarfire.org
                        visibility: public
                      - domainName: localhost
                        visibility: public
                      - domainName: a1.jarfire.org
                        visibility: private
      deprecated: false
components:
  schemas:
    ResponseDomainList:
      properties:
        meta:
          $ref: '#/components/schemas/PaginationMeta'
        data:
          description: Domain List
          type: array
          items:
            type: object
            properties:
              domainName:
                type: string
                description: Domain Name
              visibility:
                type: string
                description: Domain visibility
            required:
              - domainName
              - visibility
    PaginationMeta:
      description: Pagination Meta Data, including pages, total results...
      type: object
      properties:
        total:
          description: Total Number of Results
          type: number
          example: 233
        perPage:
          description: Total Number of Results
          type: number
          example: 233
        currentPage:
          description: Current Page Number
          type: number
          example: 7
        lastPage:
          description: Last Page Number
          type: number
          example: 97
        firstPage:
          description: First Page Number
          type: number
          example: 1

````