> ## 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 Prospects

> List All Prospects



## OpenAPI

````yaml openapi.json get /v1/prospects
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/prospects:
    get:
      tags:
        - Prospects
      summary: List All Prospects
      description: List All Prospects
      operationId: listProspectsV1
      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 prospects retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Prospect-Output'
                title: Response Listprospectsv1
              example:
                - id: pro.1731301754.OZSMSU1S
                  orgId: org.1726902940.GZChqlpU
                  name: Hari
                  phoneNumber: 96260-12778
                  externalReference: []
                  status: SERVICE_ORDER_PLACED
                  prospectProps: {}
                  createdBy: trata-system
                  createdAt: '2024-11-11T05:09:14.979287'
                  updatedBy: trata-system
                  updatedAt: '2024-11-11T05:09:14.979289'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    SortOrder:
      type: string
      enum:
        - asc
        - desc
      title: SortOrder
    Prospect-Output:
      properties:
        id:
          type: string
          title: Id
        orgId:
          type: string
          title: Orgid
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
        phoneNumber:
          anyOf:
            - type: string
            - type: 'null'
          title: Phonenumber
        externalReference:
          anyOf:
            - items:
                $ref: '#/components/schemas/ExternalReference'
              type: array
            - type: 'null'
          title: Externalreference
        status:
          type: string
          title: Status
        prospectProps:
          anyOf:
            - type: object
            - type: 'null'
          title: Prospectprops
        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:
        - id
        - externalReference
        - status
        - prospectProps
      title: Prospect
      description: Prospects are the potential customers for business
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ExternalReference:
      properties:
        providerName:
          type: string
          maxLength: 512
          minLength: 1
          title: Providername
          description: External service provider name
          example: Google Analytics
        id:
          type: string
          maxLength: 512
          minLength: 1
          title: Id
          description: External service identifier
          example: GA-123456
        providerProps:
          anyOf:
            - type: object
            - type: 'null'
          title: Providerprops
          description: Props for the external reference
          example: abcdefg
      type: object
      required:
        - providerName
        - id
      title: ExternalReference
    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
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````