GEgetswipe
Customer V2

Get list of customers

Changed on

Lists your customers with their basic details.

get/v2/customer/list

Request

  • Base URL
    https://app.getswipe.in/api/partner
  • URL
    https://app.getswipe.in/api/partner/v2/customer/list
  • Auth
    HTTP bearer

Query parameters

num_recordsstring

Number of records to fetch(max 100), default : 25 customers will be sent in response

pageinteger

Page number

Response

Customer List fetched successfully

successboolean

Success flag

messagestring

Response message

error_codestring

Error Code

errorsobject

Errors

Example response

{
  "success": true,
  "data": {
    "customers": [
      {
        "customer_id": "CUST-2",
        "name": "Customer",
        "phone": "1234567890",
        "email": "john@doe.com",
        "developer_note": "This is a developer note"
      }
    ],
    "total_records": 10
  }
}

Changes

  • 0bcdbc62187bRevision changes
    • breaking

      for the query request parameter num_records, default value 25 was added

    • info

      api operation id v2_get_customer_list removed and replaced with get_customer_list

    • info

      for the query request parameter num_records, the type was generalized from integer to string

    • info

      added the optional property /// to the response with the status