v1

latestOpenAPI 3.1.02026-07-2414704.6 MB

List Person

Instantpay's List Person API helps businesses manage their contacts. It provides deep insights into their network of individuals. This API lists all existing contacts. It provides insights for better decision-making and communication.

Integrating the List Person API lets organisations analyse and segment their contacts. This enables a targeted, personalised approach to relationship management. This feature helps businesses better understand their contacts. It enables more effective and tailored communication.

get/person

Response

200

statuscodestring

{"stackTrail":"paths:/person:get:responses:200:content:application/json:schema:properties:actcode","oasType":"schema","type":"unknown"}

statusstring

timestampstring

ipay_uuidstring

{"stackTrail":"paths:/person:get:responses:200:content:application/json:schema:properties:orderid","oasType":"schema","type":"unknown"}

environmentstring

{"stackTrail":"paths:/person:get:responses:200:content:application/json:schema:properties:internalCode","oasType":"schema","type":"unknown"}

Example response

{
  "statuscode": "TXN",
  "status": "Transaction Successful",
  "data": [
    {
      "_id": "6453969c6e9109027e051202",
      "gcId": "645383ba4acec95a32089822",
      "contactPersonName": "Sample Name",
      "email": "help@instantpay.in",
      "mobile": "7428585742",
      "description": "test desc",
      "callingCode": "+91",
      "updated_at": "2023-05-04T11:27:24.956000Z",
      "created_at": "2023-05-04T11:27:24.956000Z"
    }
  ],
  "timestamp": "2023-05-04 16:57:46",
  "ipay_uuid": "h00599160bd1-3f46-4482-91b3-d05c45df1bc1",
  "environment": "LIVE"
}