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

# List Addy's Leads

> Customers Addy has talked to, best leads first.



## OpenAPI

````yaml GET /api/pub/addy/leads
openapi: 3.1.0
info:
  title: AdsEra REST API
  description: >-
    Welcome to the AdsEra REST API. Use our API to integrate powerful,
    multi-channel communication (Email and WhatsApp) directly into your
    applications. Automate transactional messages, trigger marketing campaigns,
    manage your audience, and track performance programmatically.
  contact:
    name: Shubham
    email: shubham@adsera.in
  version: 1.0.0
servers:
  - url: https://app.adsera.in
    description: Production Server
security:
  - AppIdAuth: []
    AppSecretAuth: []
paths:
  /api/pub/addy/leads:
    get:
      tags:
        - AI Agent (Addy)
      summary: List Addy's Leads
      description: Customers Addy has talked to, best leads first.
      operationId: addyLeads
      parameters:
        - name: temperature
          in: query
          required: false
          description: Only these temperatures, comma-separated.
          schema:
            type: string
            example: hot,warm
        - name: stage
          in: query
          required: false
          description: Only these stages, comma-separated.
          schema:
            type: string
            example: qualified,booked
        - name: minScore
          in: query
          required: false
          description: Only leads with at least this score.
          schema:
            type: integer
            example: 70
        - name: updatedSince
          in: query
          required: false
          description: >-
            Only chats that changed since this time. Use it to sync every few
            minutes.
          schema:
            type: string
            format: date-time
        - name: page
          in: query
          required: false
          description: Page, from 1.
          schema:
            type: integer
            example: 1
        - name: perPage
          in: query
          required: false
          description: Leads per page, at most 100. Default 25.
          schema:
            type: integer
            example: 25
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      items:
                        type: array
                        items:
                          $ref: '#/components/schemas/AddyConversation'
                      total:
                        type: integer
                      page:
                        type: integer
                      perPage:
                        type: integer
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            Your plan has no API access, has expired, or doesn't include
            WhatsApp.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmError'
components:
  schemas:
    AddyConversation:
      type: object
      properties:
        contact:
          type: string
          example: '919876543210'
        contactId:
          type: string
        whatsapp:
          type: string
          description: Id of your WhatsApp number this chat is on.
        status:
          type: string
          enum:
            - active
            - handed_off
            - paused
          nullable: true
          description: >-
            active: Addy is talking. handed_off: Addy passed the chat to your
            team. null: Addy hasn't talked to this customer yet.
        summary:
          type: string
          nullable: true
          example: >-
            Runs 3 salons in Pune; wants WhatsApp reminders for appointments;
            asked about pricing for 3 users.
        learned:
          type: object
          additionalProperties: true
          example:
            business_type: Salon
            team_size: '3'
            timeline: this month
          description: Answers to Addy's qualifying questions so far.
        lead:
          $ref: '#/components/schemas/AddyLead'
        handoff:
          type: object
          nullable: true
          description: When Addy last passed the chat to your team, and why.
          properties:
            reason:
              type: string
            summary:
              type: string
            at:
              type: string
              format: date-time
        booked:
          type: boolean
          description: Addy booked a meeting with this customer.
        order:
          type: object
          nullable: true
          description: The order Addy took in the chat.
          properties:
            status:
              type: string
              enum:
                - pending
                - paid
                - failed
            total:
              type: number
            currency:
              type: string
            via:
              type: string
              enum:
                - whatsapp
                - link
                - team
            at:
              type: string
              format: date-time
            paidAt:
              type: string
              format: date-time
              nullable: true
        replies:
          type: integer
          description: How many messages Addy has sent in this chat.
        lastCustomerMessageAt:
          type: string
          format: date-time
          nullable: true
        lastReplyAt:
          type: string
          format: date-time
          nullable: true
    CrmError:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          example: Contact not found
    AddyLead:
      type: object
      properties:
        score:
          type: integer
          example: 82
          description: 0–100. How likely this customer is to buy, from what they told Addy.
        temperature:
          type: string
          enum:
            - cold
            - warm
            - hot
          example: hot
        stage:
          type: string
          enum:
            - new
            - engaged
            - qualified
            - hot
            - booked
            - ordered
            - paid
            - lost
          example: qualified
        reason:
          type: string
          nullable: true
          example: Has budget, needs it this month, decision maker.
        updatedAt:
          type: string
          format: date-time
          nullable: true
    ErrorResponse:
      type: object
      properties:
        status:
          type: integer
          example: 500
        success:
          type: boolean
          example: false
        error:
          type: string
          example: Internal Server Error!
  responses:
    Unauthorized:
      description: Unauthorized. The API keys are missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status: 401
            success: false
            error: 'Unauthorized: Please provide valid API credentials.'
  securitySchemes:
    AppIdAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Your application's unique ID.
    AppSecretAuth:
      type: apiKey
      in: header
      name: x-api-secret
      description: Your application's secret key.

````

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