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

# Get contacts for list generator

> Returns a paginated, lightweight list of contacts for the bulk-messaging list-generator UI. Supports stage / time-range / date-range / message-status / message-count filters; results are scoped to the caller's organization.



## OpenAPI

````yaml /api-reference/openapi.yaml get /api/contact/list-generator
openapi: 3.0.3
info:
  title: Tether Relay and Tether API
  version: 1.0.0
  description: >-
    Route-derived OpenAPI contract generated from tether-relay backend sources.
    Regenerate with scripts/sync-openapi-from-backend.mjs.
servers:
  - url: https://your-instance.example.com
    description: Production
  - url: http://localhost:2212
    description: Local API service
security: []
tags:
  - name: AI
  - name: Applications
  - name: Approval
  - name: Auth
  - name: Automations
  - name: Calls
  - name: Campaigns
  - name: Contact Analytics
  - name: Contact Metrics
  - name: Contact Notes
  - name: Contacts
  - name: Conversation Monitor
  - name: Conversations
  - name: Departments
  - name: Email
  - name: Escalation Dashboard
  - name: Event Logs
  - name: Google Sheets
  - name: Marketplace
  - name: Messages
  - name: Notification Sounds
  - name: Notifications
  - name: Org Snapshots
  - name: Organizations
  - name: Outreach
  - name: Outreach Metrics
  - name: Outreach Sources
  - name: Pipelines
  - name: Processes
  - name: Prompts
  - name: Reminders
  - name: Sms
  - name: Templates
  - name: Traces
  - name: Training
  - name: Upload
  - name: User Snapshots
  - name: Users
  - name: Vertical
  - name: Webchats
  - name: Webhook
paths:
  /api/contact/list-generator:
    get:
      tags:
        - Contacts
      summary: Get contacts for list generator
      description: >-
        Returns a paginated, lightweight list of contacts for the bulk-messaging
        list-generator UI. Supports stage / time-range / date-range /
        message-status / message-count filters; results are scoped to the
        caller's organization.
      operationId: get_contact_list_generator
      parameters:
        - in: query
          name: stages
          required: false
          schema:
            type: string
            description: JSON array
        - in: query
          name: timeRange
          required: false
          schema:
            type: string
            description: JSON object
        - in: query
          name: dateRange
          required: false
          schema:
            type: string
            description: JSON object
        - in: query
          name: page
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
        - in: query
          name: limit
          required: false
          schema:
            type: integer
            minimum: 1
            default: 10
        - in: query
          name: searchValue
          required: false
          schema:
            type: string
        - in: query
          name: messageStatus
          required: false
          schema:
            type: string
            enum:
              - all
              - answered
              - unanswered
        - in: query
          name: messageCountValue
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: Contacts returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGeneratorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
      security:
        - bearerAuth: []
components:
  schemas:
    ListGeneratorResponse:
      type: object
      properties:
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/ListGeneratorContact'
        total:
          type: integer
        page:
          type: integer
        limit:
          type: integer
        totalPages:
          type: integer
      additionalProperties: true
      example:
        contacts: []
        total: 0
        page: 1
        limit: 10
        totalPages: 0
    ApiErrorEnvelope:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        message:
          type: string
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
          required:
            - message
          additionalProperties: true
      required:
        - success
        - error
      additionalProperties: true
      example:
        success: false
        message: Contact not found
        error:
          code: NOT_FOUND
          message: Contact not found
    ListGeneratorContact:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        phoneNumber:
          type: string
        email:
          type: string
        status:
          type: string
        pipelineStage:
          type: string
        lastMessageDate:
          type: string
          format: date-time
          nullable: true
        messageCount:
          type: integer
      additionalProperties: true
      example:
        id: 64f0a1b2c3d4e5f6a7b8c9d0
        name: Jane Doe
        phoneNumber: '+14165550100'
        email: jane.doe@example.com
        status: New Lead
        pipelineStage: 64f0a1b2c3d4e5f6a7b8c9d2
        lastMessageDate: '2026-05-15T09:12:00.000Z'
        messageCount: 3
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````