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

# List All Hives

> List All Hives



## OpenAPI

````yaml openapi.json get /v1/hives
openapi: 3.1.0
info:
  title: Trata AI API
  description: >-
    Human like conversation to answer calls, drive engagement, automate
    follow-ups & schedule bookings 24/7  with end to end integrations ensuring
    you never miss a sales enquiry.
  version: 1.0.0
servers:
  - url: https://api.trata.ai
    description: Production
  - url: http://localhost:8000
    description: Development
security: []
paths:
  /v1/hives:
    get:
      tags:
        - Hive
      summary: List All Hives
      description: List All Hives
      operationId: listHivesV1
      parameters:
        - name: search_by
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Field name to search by
            title: Search By
          description: Field name to search by
          example: name
        - name: search_value
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Value to search for in the specified field
            title: Search Value
          description: Value to search for in the specified field
          example: search term
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by status
            title: Status
          description: Filter by status
          example: active
        - name: sort_by
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Field to sort by
            title: Sort By
          description: Field to sort by
          example: createdAt
        - name: sort_order
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/SortOrder'
              - type: 'null'
            description: Sort order (asc or desc)
            default: asc
            title: Sort Order
          description: Sort order (asc or desc)
        - name: skip
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            description: Number of records to skip
            default: 0
            title: Skip
          description: Number of records to skip
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Maximum number of records to return
            default: 100
            title: Limit
          description: Maximum number of records to return
      responses:
        '200':
          description: List of hives retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Hive'
                title: Response Listhivesv1
              example:
                - id: hiv.1727418138.IPGwVl1f
                  orgId: org.1726902940.GZChqlpU
                  content:
                    hiveType: WEBSITE
                    url: https://www.cotekoreansteakhouse.com/
                    hiveProps:
                      crawl_child_pages: true
                  status: completed
                  createdBy: org.1726902940.GZChqlpU
                  createdAt: '2024-09-27T06:22:18.000277'
                  updatedBy: trata-system
                  updatedAt: '2024-09-27T06:27:34.276065'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    SortOrder:
      type: string
      enum:
        - asc
        - desc
      title: SortOrder
    Hive:
      properties:
        id:
          type: string
          title: Id
        orgId:
          type: string
          title: Orgid
        content:
          $ref: '#/components/schemas/HiveContent-Output'
        status:
          type: string
          title: Status
        createdBy:
          type: string
          title: Createdby
        createdAt:
          type: string
          format: date-time
          title: Createdat
        updatedBy:
          type: string
          title: Updatedby
        updatedAt:
          type: string
          format: date-time
          title: Updatedat
      type: object
      required:
        - content
        - status
      title: Hive
      description: Reference to all business knowledge base will be stored in Hive
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    HiveContent-Output:
      properties:
        hiveType:
          $ref: '#/components/schemas/HiveType'
        url:
          anyOf:
            - type: string
              maxLength: 512
              minLength: 1
            - type: 'null'
          title: Url
          description: URL of the content
        files:
          anyOf:
            - items:
                $ref: '#/components/schemas/Files'
              type: array
            - type: 'null'
          title: Files
          description: List of files to be referenced for the hive
        hiveProps:
          anyOf:
            - type: object
            - type: 'null'
          title: Hiveprops
          description: >-
            To recursively crawl child pages, add this as props
            {"crawl_child_pages": true},  "depth": "3"
        internalProps:
          anyOf:
            - type: object
            - type: 'null'
          title: Internalprops
          description: >-
            To add any internal props, add this as props {"last_crawl_time":
            "123123123123"}
      type: object
      required:
        - hiveType
      title: HiveContent
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    HiveType:
      type: string
      enum:
        - WEBSITE
        - GOOGLE_DOCS
        - DOCS
        - TRANSCRIPTS
      title: HiveType
    Files:
      properties:
        id:
          type: string
          title: Id
        orgId:
          type: string
          title: Orgid
        fileName:
          type: string
          title: Filename
        fileUrl:
          type: string
          title: Fileurl
        createdBy:
          type: string
          title: Createdby
        createdAt:
          type: string
          format: date-time
          title: Createdat
        updatedBy:
          type: string
          title: Updatedby
        updatedAt:
          type: string
          format: date-time
          title: Updatedat
      type: object
      title: Files
      description: Stores the map of file id with respective file URL in storage manager
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````