> ## 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 vendors

> Lists your vendors with their basic details.



## OpenAPI

````yaml get /v2/vendor/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/vendor/list:
    get:
      tags:
        - Vendor V2
      summary: Get list of vendors
      description: Lists your vendors with their basic details.
      operationId: get_vendor_list
      parameters:
        - name: num_records
          in: query
          description: >-
            Number of records to fetch, default : all vendors will be sent in
            response
          schema:
            type: integer
        - name: page
          in: query
          description: Page number
          schema:
            type: integer
            default: 1
      responses:
        '200':
          description: Vendor List fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGETResponseVendor'
        '400':
          description: Error in fetching Vendor List
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VendorResponseV2'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VendorResponseV2'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VendorResponseV2'
components:
  schemas:
    ListGETResponseVendor:
      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/VendorList'
      type: object
    VendorResponseV2:
      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
    VendorList:
      properties:
        vendors:
          type: array
          items:
            $ref: '#/components/schemas/VendorListRecord'
        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
    VendorListRecord:
      properties:
        vendor_id:
          type: string
          description: vendor ID
          example: CUST-2
        name:
          type: string
          description: Name of the vendor
          example: vendor
        phone:
          type: string
          description: Phone Number of the vendor
          example: '1234567890'
        email:
          type: string
          description: Email of the vendor
          example: john@doe.com
        gstin:
          type: string
          description: GSTIN of the vendor
          example: ''
        swipe_id:
          type: string
          description: Swipe ID assigned to the vendor
          example: 1
      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.

````