GET
/
v1
/
customer
/
list
curl --request GET \
  --url https://app.getswipe.in/api/partner/v1/customer/list \
  --header 'Authorization: <api-key>'
{
  "success": true,
  "message": "",
  "error_code": "",
  "errors": {},
  "data": {
    "customers": [
      {
        "customer_id": "CUST-2",
        "name": "Customer",
        "phone": "1234567890",
        "email": "john@doe.com",
        "gstin": "",
        "swipe_id": "1"
      }
    ],
    "total_records": 10
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
num_records
integer

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

​
page
integer
default:1

Page number

Response

200
application/json

Customer List fetched successfully

The response is of type object.