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

# All List

> Fetches a paginated list of contacts. You can filter the results using a search query.



## OpenAPI

````yaml GET /v2/contact/
openapi: 3.1.0
info:
  title: CloserX.ai API
  description: >-
    The CloserX.ai API provides programmatic access to manage AI-powered calling
    operations, including agent creation, campaign management, contact handling,
    telephony integration, and more. This API enables seamless automation and
    integration with CRM systems, telephony providers, and other third-party
    services for enhanced client communication and business operations.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://app.closerx.ai/api
security:
  - api_key: []
paths:
  /v2/contact/:
    get:
      summary: Retrieve contact list with optional search and pagination
      description: >-
        Fetches a paginated list of contacts. You can filter the results using a
        search query.
      parameters:
        - name: Company-Name
          in: header
          required: true
          description: The schema name for multi-tenancy (company-wise DB separation)
          schema:
            type: string
        - name: page
          in: query
          required: false
          description: Page number for pagination
          schema:
            type: integer
            example: 1
        - name: search
          in: query
          required: false
          description: Search term to filter contacts by name, number, or other fields
          schema:
            type: string
            example: john
      responses:
        '200':
          description: Successfully retrieved contact list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactList'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    ContactList:
      type: object
      properties:
        total_count:
          type: integer
          description: Total number of contacts available
        total_page:
          type: integer
          description: Total number of pages for pagination
        current_page_no:
          type: integer
          description: The current page number being viewed
        next_page_number:
          type:
            - integer
            - 'null'
          description: The next page number if available, otherwise null
        previous_page_number:
          type:
            - integer
            - 'null'
          description: The previous page number if available, otherwise null
        page_size:
          type: integer
          description: The number of contacts per page
        data:
          type: array
          description: List of contact objects for the current page
          items:
            type: object
            properties:
              id:
                type: integer
                description: Unique ID of the contact
              contact_number:
                type: string
                description: Phone number of the contact
              email:
                type: string
                description: Email address of the contact
              first_name:
                type:
                  - string
                  - 'null'
                description: First name of the contact
              last_name:
                type:
                  - string
                  - 'null'
                description: Last name of the contact
              company_name:
                type:
                  - string
                  - 'null'
                description: Company associated with the contact
              industry:
                type:
                  - string
                  - 'null'
                description: Industry the contact belongs to
              custom1:
                type:
                  - string
                  - 'null'
                description: Custom field 1
              custom2:
                type:
                  - string
                  - 'null'
                description: Custom field 2
              custom3:
                type:
                  - string
                  - 'null'
                description: Custom field 3
              custom4:
                type:
                  - string
                  - 'null'
                description: Custom field 4
              isactive:
                type: boolean
                description: Indicates if the contact is active
              address:
                type:
                  - string
                  - 'null'
                description: Address of the contact
              contact_id:
                type:
                  - string
                  - 'null'
                description: External contact ID or integration ID
              tags:
                type: array
                description: List of tags associated with the contact
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                      description: Unique ID of the tag
                    tag_name:
                      type: string
                      description: Name of the tag
                  required:
                    - id
                    - tag_name
            required:
              - id
              - contact_number
              - isactive
              - tags
      required:
        - total_count
        - total_page
        - current_page_no
        - next_page_number
        - previous_page_number
        - page_size
        - data
    Error:
      required:
        - success
        - message
        - data
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: api_key

````