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

# List all customers for your tenant



## OpenAPI

````yaml /openapi.json get /api/v1/customers
openapi: 3.0.0
info:
  title: g-tateth CRM API
  version: 1.1.0
  description: >-
    RESTful API for g-tateth CRM platform. Manage conversations, customers,
    users, and more.
  contact:
    name: g-tateth Support
    email: support@g-tateth.com
  license:
    name: Proprietary
servers:
  - url: https://api.g-tateth.com
    description: Production server
  - url: https://staging-api.g-tateth.com
    description: Staging server
security: []
tags:
  - name: Health
    description: API health and status check (no authentication required)
  - name: Authentication
    description: API key and JWT authentication
  - name: API Keys
    description: Create and manage your tenant API keys (requires JWT session)
  - name: Conversations
    description: Manage customer conversations (supports API key or JWT)
  - name: Customers
    description: Manage customer profiles (supports API key or JWT)
  - name: Webhooks
    description: Subscribe to real-time events via webhooks (supports API key or JWT)
  - name: Analytics
    description: Usage analytics and performance metrics (supports API key or JWT)
  - name: Data Privacy
    description: >-
      GDPR data rights endpoints — export, deletion, access, rectification,
      restriction, and objection requests (requires JWT session)
  - name: Widget
    description: Chat widget API endpoints (public — no authentication required)
  - name: Telephony
    description: Voice and phone API endpoints
  - name: Zoho Integration
    description: Zoho CRM integration and data import endpoints
paths:
  /api/v1/customers:
    get:
      tags:
        - Customers
      summary: List all customers for your tenant
      parameters:
        - in: query
          name: search
          schema:
            type: string
          description: Search by name, email, phone, or company
        - in: query
          name: tier
          schema:
            type: string
            enum:
              - bronze
              - silver
              - gold
              - platinum
          description: Filter by customer tier
        - in: query
          name: status
          schema:
            type: string
            enum:
              - active
              - inactive
              - archived
          description: Filter by status
        - in: query
          name: tags
          schema:
            type: array
            items:
              type: string
          description: Filter by tags
        - in: query
          name: page
          schema:
            type: integer
            default: 1
          description: Page number
        - in: query
          name: limit
          schema:
            type: integer
            default: 20
            maximum: 100
          description: Items per page
      responses:
        '200':
          description: List of customers
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Customer'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  schemas:
    Customer:
      type: object
      properties:
        _id:
          type: string
          example: 64a1b2c3d4e5f6789012345b
        profile:
          type: object
          properties:
            firstName:
              type: string
              example: Jane
            lastName:
              type: string
              example: Smith
            email:
              type: string
              format: email
              example: jane.smith@example.com
            phone:
              type: string
              example: '+2348012345678'
            company:
              type: string
              example: Acme Corp
            jobTitle:
              type: string
              example: Head of Operations
        tier:
          type: string
          enum:
            - bronze
            - silver
            - gold
            - platinum
          default: bronze
          example: gold
        status:
          type: string
          enum:
            - active
            - inactive
            - archived
          example: active
        tags:
          type: array
          items:
            type: string
          example:
            - vip
            - enterprise
        customFields:
          type: object
          additionalProperties: true
          description: Arbitrary key-value pairs for tenant-specific fields
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Pagination:
      type: object
      properties:
        total:
          type: number
          example: 100
        page:
          type: number
          example: 1
        limit:
          type: number
          example: 20
        totalPages:
          type: number
          example: 5
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API Key authentication. Format: `Bearer sk_live_...` (production) or
        `Bearer sk_test_...` (staging). Obtain keys from Settings → Developer
        Console.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT session token authentication. Use for user-context requests. The
        token is returned by the login endpoint and expires after 15 minutes.

````