Sign in
CRM

Fetches the crm interactions of a given date (Only allows the past dates). This API returns at max 100 records in one page

get/crm/interactions

Query parameters

datestring
Example:2020-05-25

Date for which crm interactions should be fetched. Accepted format is YYYY-MM-DD. Only the past dates are allowed.

pageNonumber required

Requested Page number

processNamestring
Example:Default Proccess

Name of the proccess for which crm interactions should be fetched.

isLatestOnlyboolean

When true this api fetches the latest interaction of each customer on the given day. It is false by default.

Response

If the auth token is valid.

statusCodenumber

Will be 0 in case of success

messagestring

Contains the success message or error reason, based on the statusCode

Example response

{
  "statusCode": 0,
  "message": "Successfully fetched the interactions list",
  "data": {
    "metadata": [
      {
        "total": 1,
        "page": 1
      }
    ],
    "data": [
      {
        "customer": {
          "id": "5f5a5a5a5a5a5a5a5a5a5a5a",
          "name": "Rohit Agarwal",
          "phoneNumber": "+919898989898",
          "email": "rohit.agarwal@gmail.com",
          "company": {
            "name": "Agarwal Foods Limited",
            "address": {
              "street": "84-2, Main road",
              "city": "RAIPUR",
              "state": "Chattisgarh",
              "country": "India",
              "pincode": 578100
            },
            "kdm": {
              "name": "Varun Agarwal",
              "phoneNumber": "+919696969696"
            }
          }
        },
        "priority": 3,
        "notes": "Customer is interested and asked to drop details on mail. Scheduling a followup with Priyank to take the discussion forward",
        "assigned": {
          "from": "Rahul Singh",
          "to": "Priyank Gupta"
        },
        "createdAt": 1600486640,
        "userFields": [
          {
            "name": "source",
            "value": "Website enquiry"
          },
          {
            "name": "followup On",
            "value": 1600862400
          },
          {
            "name": "status",
            "value": "Hot Followup"
          }
        ]
      }
    ]
  }
}

Changes