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

# List Contacts

> List Contacts.

### Authorizations

<ParamField header="X-Api-Key" type="string" required>
  Your Agni API key used to authenticate the request. Pass it in the `X-Api-Key` header. Find or rotate it from your Ravan AI account settings.
</ParamField>

***

### Query Parameters

<ParamField query="search" type="string">
  A search string used to filter matching records by supported text fields.
</ParamField>

<ParamField query="limit" type="integer">
  The maximum number of records to return. Use this with `offset` or pagination fields to page through results.
</ParamField>

<ParamField query="offset" type="integer">
  The number of records to skip before returning results. Use this with `limit` for pagination.
</ParamField>

***

### Response

<ResponseField name="success" type="boolean">
  Whether the request succeeded.
</ResponseField>

<ResponseField name="message" type="string">
  Human-readable status message.
</ResponseField>

<ResponseField name="data" type="array">
  Array of contact objects.
</ResponseField>

<ResponseField name="meta" type="object">
  Pagination metadata.
</ResponseField>


## OpenAPI

````yaml GET /api/v1/contacts/
openapi: 3.0.1
info:
  title: Agni API
  version: 1.0.0
  description: >-
    Agni API for managing agents, tools, widget settings, telephony, and
    integrations.
servers:
  - url: https://api.ravan.ai
security:
  - X-Api-Key: []
tags:
  - name: AgentService
  - name: AgentToolService
  - name: WidgetSettingsService
  - name: PhoneService
  - name: AppointmentService
  - name: GHLService
  - name: CalComService
  - name: CampaignService
  - name: ContactService
  - name: CallingService
  - name: RAGService
  - name: ModelService
  - name: HealthService
paths:
  /api/v1/contacts/:
    get:
      tags:
        - ContactService
      summary: List Contacts
      operationId: ListContacts
      parameters:
        - name: search
          in: query
          schema:
            type: string
          description: Search term
        - name: limit
          in: query
          schema:
            type: integer
          description: Number of results
        - name: offset
          in: query
          schema:
            type: integer
          description: Pagination offset
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListContactsResponse'
components:
  schemas:
    ListContactsResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/Contact'
        meta:
          $ref: '#/components/schemas/Meta'
    Contact:
      type: object
      properties:
        id:
          type: string
          description: Contact ID
        first_name:
          type: string
          description: First name
        last_name:
          type: string
          description: Last name
        email:
          type: string
          description: Email address
        phone:
          type: string
          description: Phone number
        company:
          type: string
          description: Company name
        metadata:
          type: object
          description: Custom metadata
        created_at:
          type: string
          description: Creation timestamp
        updated_at:
          type: string
          description: Last update timestamp
    Meta:
      type: object
      properties:
        total:
          type: integer
          format: int64
          description: Total number of records
        limit:
          type: integer
          format: int32
          description: Page size limit
        offset:
          type: integer
          format: int32
          description: Pagination offset
  securitySchemes:
    X-Api-Key:
      type: apiKey
      in: header
      name: X-Api-Key

````