Fetch List of Leads in DND List

This API allows you to fetch list of lead of the account DND List.

Sample Request

curl --request GET \
     --url https://api.servetel.in/v1/broadcast/dnd/leads \
     --header 'accept: application/json'

📘 Important!

Before we begin, note that the * sign denotes the mandatory variables in each table.

Request Variables (Query Params)

The following parameter is required to Fetch List of Leads in DND List.

Variable NameDescriptionData Type
limitNumber of records to be fetched. Min: 1 max: 100.String
last_seen_idReference ID of last user in the page.String
list_idID of the list to be fetched.String
idUnique ID of the Account DND list.String

Sample Response

  "hasMore": false,
  "count": 1,
  "limit": 10,
  "data": [
      "id": "64d336a9706560031227a2b2",
      "list_id": 259,
      "added_by": 10959,
      "number": "9876543210",
      "type": "number",
      "created_at": "2023-08-09T12:18:09+0530"

Response Variables

The response returned is as following:

Variable NameDescriptionData Type
hasMoreIt defines whether there exist more records or not. For example: true or false.Boolean
countTotal number of records in current page.Integer
limitNumber of records to be fetched.Integer
data[].idId of the lead.String
data[].list_idID of the list fetched.String
data[].added_byClient ID of who added this lead to the list.String
data[].numberNumber of the lead.String
data[].typeType of data for eg: number or lead_id.String
data[].created_atTime stamp when the list was created.String
Click Try It! to start a request and see the response here!