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

# List contacts

> Returns a paginated list of contacts.



## OpenAPI

````yaml /api-reference/openapi.en.json get /v1/contacts
openapi: 3.1.0
info:
  title: Timely.ai API
  description: >-
    Timely.ai REST API for AI-powered customer service automation. Manage
    agents, conversations, contacts, and integrations.
  version: 1.0.0
  contact:
    name: Timely.ai
    email: contato@timelyai.com.br
    url: https://timelyai.com.br
servers:
  - url: https://api.timelyai.com.br
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: System
    description: Health check and API key introspection
  - name: Agents
    description: AI agents — creation, configuration, and management
  - name: Trainings
    description: Agent knowledge bases
  - name: Channels
    description: Communication channels (WhatsApp, Telegram, Email, Website)
  - name: Contacts
    description: Customer records
  - name: Conversations
    description: Conversation history and messages
  - name: Custom Fields
    description: CRM custom fields
  - name: Chats
    description: Active chat operations and human handoff
  - name: Messages
    description: Individual messages
  - name: MCP
    description: Model Context Protocol — servers and tools
  - name: Webhooks
    description: Outbound webhooks for real-time events
paths:
  /v1/contacts:
    get:
      tags:
        - Contacts
      summary: List contacts
      description: Returns a paginated list of contacts.
      operationId: listContacts
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Order'
        - $ref: '#/components/parameters/Search'
        - name: status
          in: query
          schema:
            type: string
            enum:
              - active
              - inactive
              - blocked
      responses:
        '200':
          description: List of contacts
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Contact'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    Page:
      name: page
      in: query
      description: Page number
      schema:
        type: integer
        minimum: 1
        default: 1
    Limit:
      name: limit
      in: query
      description: Items per page
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
    Order:
      name: order
      in: query
      description: Sort direction
      schema:
        type: string
        enum:
          - asc
          - desc
        default: desc
    Search:
      name: search
      in: query
      description: Search term
      schema:
        type: string
  schemas:
    Contact:
      type: object
      properties:
        id:
          type: string
          format: uuid
        customer_name:
          type: string
        customer_email:
          type: string
          format: email
        customer_phone:
          type: string
        status:
          type: string
          enum:
            - active
            - inactive
            - blocked
        tags:
          type: array
          items:
            type: string
        custom_fields:
          type: object
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Pagination:
      type: object
      properties:
        page:
          type: integer
        limit:
          type: integer
        total:
          type: integer
        total_pages:
          type: integer
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            status:
              type: integer
  responses:
    Unauthorized:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key obtained from the dashboard

````