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

# List Live Updates

> Get all live updates for the authenticated user's team. Supports filtering and pagination for efficient data retrieval.




## OpenAPI

````yaml /openapi.yaml get /live-updates
openapi: 3.0.0
info:
  title: Answering Agent API
  description: API for Answering Agent platform
  version: 1.0.0
servers:
  - url: https://answeringagent.com/api/v1
    description: Production API
  - url: https://playground.answeringagent.com/api/v1
    description: Playground API
security: []
paths:
  /live-updates:
    get:
      tags:
        - Live Updates
      summary: List Live Updates
      description: >
        Get all live updates for the authenticated user's team. Supports
        filtering and pagination for efficient data retrieval.
      operationId: listLiveUpdates
      parameters:
        - in: query
          name: phone_number_id
          schema:
            type: integer
          description: Filter updates by specific phone number/location
        - in: query
          name: type
          schema:
            type: string
            enum:
              - announcement
              - wait_time
              - flash_sale
              - closure
              - schedule_change
          description: Filter updates by type
        - in: query
          name: status
          schema:
            type: string
            enum:
              - scheduled
              - active
              - expired
              - cancelled
          description: Filter updates by current status
        - in: query
          name: active_only
          schema:
            type: boolean
          description: If true, only return currently active updates
        - in: query
          name: not_expired_only
          schema:
            type: boolean
          description: >-
            If true, include both active and scheduled updates while excluding
            expired ones
        - in: query
          name: per_page
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          description: Number of items per page for pagination
      responses:
        '200':
          description: Paginated list of live updates
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LiveUpdate'
                  links:
                    $ref: '#/components/schemas/PaginationLinks'
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: No team selected or insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: No team selected.
      security:
        - BearerAuth: []
components:
  schemas:
    LiveUpdate:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for the live update
          example: 1
        title:
          type: string
          description: Title of the live update
          example: Temporary System Maintenance
          maxLength: 255
        message:
          type: string
          description: Detailed message for the live update
          example: >-
            We are currently performing system maintenance. Expected completion
            time is 2 PM.
          maxLength: 2000
        link:
          type: string
          format: uri
          nullable: true
          description: >-
            Optional URL for Flash Sale updates. Active Flash Sale links are
            available as text links.
          example: https://example.com/weekend-sale
          maxLength: 500
        type:
          type: string
          description: Type of live update
          enum:
            - announcement
            - wait_time
            - flash_sale
            - closure
            - schedule_change
          example: announcement
        starts_at:
          type: string
          format: date-time
          description: When the live update becomes active (ISO 8601 format)
          example: '2025-07-25T14:00:00Z'
        expires_at:
          type: string
          format: date-time
          nullable: true
          description: When the live update expires (null for no expiration)
          example: '2025-07-25T16:00:00Z'
        is_cancelled:
          type: boolean
          description: Whether the live update has been cancelled
          example: false
        created_at:
          type: string
          format: date-time
          description: When the live update was created
          example: '2025-07-25T10:30:00Z'
        updated_at:
          type: string
          format: date-time
          description: When the live update was last modified
          example: '2025-07-25T11:45:00Z'
        phone_numbers:
          type: array
          description: >-
            Phone numbers/locations this update applies to (empty array means
            all locations)
          items:
            type: object
            properties:
              id:
                type: integer
                description: Phone number ID
                example: 1
              name:
                type: string
                description: Location name
                example: Main Office
              phone_number:
                type: string
                description: Phone number in E.164 format
                example: '+1234567890'
        created_by:
          type: object
          description: User who created this live update
          properties:
            id:
              type: integer
              example: 1
            name:
              type: string
              example: John Doe
            email:
              type: string
              example: john@example.com
    PaginationLinks:
      type: object
      properties:
        first:
          type: string
          nullable: true
          description: URL for the first page
        last:
          type: string
          nullable: true
          description: URL for the last page
        prev:
          type: string
          nullable: true
          description: URL for the previous page
        next:
          type: string
          nullable: true
          description: URL for the next page
    PaginationMeta:
      type: object
      properties:
        current_page:
          type: integer
          description: Current page number
          example: 1
        from:
          type: integer
          nullable: true
          description: First item number on current page
          example: 1
        last_page:
          type: integer
          description: Last page number
          example: 5
        per_page:
          type: integer
          description: Number of items per page
          example: 20
        to:
          type: integer
          nullable: true
          description: Last item number on current page
          example: 20
        total:
          type: integer
          description: Total number of items
          example: 97
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: API key is required
                enum:
                  - API key is required
                  - Invalid credentials
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````