Get list of vendors

Lists your vendors with their basic details.

GET /v2/vendor/list

Get list of vendors

cURL

curl --request GET \
  --url https://app.getswipe.in/api/partner/v2/vendor/list \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "message": "",
  "error_code": "",
  "errors": {},
  "data": {
    "vendors": [
      {
        "vendor_id": "CUST-2",
        "name": "vendor",
        "phone": "1234567890",
        "email": "[e-mail]",
        "gstin": "",
        "swipe_id": 1
      }
    ],
    "total_records": 10
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is an API key from the API Integration section of your dashboard. Keys are scoped to the company they are generated in — for testing, add a separate test company and generate the key there, so requests never touch your real books.

Query Parameters

num_records · integer

Number of records to fetch, default : all vendors will be sent in response

page · integer · default: 1

Page number

Response

200

application/json

Vendor List fetched successfully

success · boolean

Success flag

Example:

true

message · string

Response message

Example:

""

error_code · string

Error Code

Example:

""

errors · object

Errors

data · object

Show child attributes