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

# Get list of customers

> Lists your customers with their basic details.



## OpenAPI

````yaml get /v2/customer/list
openapi: 3.0.1
info:
  title: SwipeAPI
  version: '2.0'
  description: >-
    The Swipe Partner API — invoicing, payments, and GST compliance for your
    application. Create GST invoices and other documents, manage customers,
    vendors, products and inventory, record payments, and generate e-invoices
    and e-way bills.


    - Docs & guides: https://developers.getswipe.in

    - Quickstart: https://developers.getswipe.in/quickstart

    - Rate limit: 1 request/second per API key

    - All dates are DD-MM-YYYY
servers:
  - url: https://app.getswipe.in/api/partner
security:
  - bearerAuth: []
paths:
  /v2/customer/list:
    get:
      tags:
        - Customer V2
      summary: Get list of customers
      description: Lists your customers with their basic details.
      operationId: get_customer_list
      parameters:
        - name: num_records
          in: query
          description: >-
            Number of records to fetch(max 100), default : 25 customers will be
            sent in response
          schema:
            type: string
            default: 25
        - name: page
          in: query
          description: Page number
          schema:
            type: integer
            default: 1
      responses:
        '200':
          description: Customer List fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGETResponse'
        '400':
          description: Error in fetching Customer List
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerResponseV2'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerResponseV2'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerResponseV2'
components:
  schemas:
    ListGETResponse:
      properties:
        success:
          type: boolean
          description: Success flag
          example: true
        message:
          type: string
          description: Response message
          example: ''
        error_code:
          type: string
          description: Error Code
          example: ''
        errors:
          type: object
          description: Errors
        data:
          $ref: '#/components/schemas/CustomerList'
      type: object
    CustomerResponseV2:
      properties:
        success:
          type: boolean
          description: Success flag
          example: true
        message:
          type: string
          description: Response message
          example: ''
        error_code:
          type: string
          description: Error Code
          example: ''
        errors:
          type: object
          description: Errors
        data:
          $ref: '#/components/schemas/EmptyData'
      type: object
    CustomerList:
      properties:
        customers:
          type: array
          items:
            $ref: '#/components/schemas/CustomerListRecord'
        total_records:
          type: integer
          description: Total Records available
          example: 10
      type: object
    EmptyData:
      properties:
        message:
          type: string
          description: Response message
          example: No data found!
      type: object
    CustomerListRecord:
      properties:
        customer_id:
          type: string
          description: Customer ID
          example: CUST-2
        name:
          type: string
          description: Name of the Customer
          example: Customer
        phone:
          type: string
          description: Phone Number of the customer
          example: '1234567890'
        email:
          type: string
          description: Email of the customer
          example: john@doe.com
        gstin:
          type: string
          description: GSTIN of the customer
          example: ''
        swipe_id:
          type: string
          description: Swipe ID assigned to the customer
          example: 1
        developer_note:
          type: string
          description: 'Developer Notes: This field is for internal use.'
          example: This is a developer note
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is an API key from the [API
        Integration](https://app.getswipe.in/user?tab=api_integration) section
        of your dashboard. Keys are scoped to the company they are generated in
        — for testing, [add a separate test
        company](https://community.getswipe.in/t/how-to-add-new-company-on-web/1191)
        and generate the key there, so requests never touch your real books.

````