Fetch List of Lead Lists

This API allows you to fetch list of lead lists.

Sample Request

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

📘 Important!

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

Sample Response

    "id": 5358,
    "name": "June Payment Collection",
    "description": "June Payment Collection",
    "sensitive_field_map": [],
    "field_map": [
      "Phone Number",
      "Email Id",
      "Company Name",
      "Due Amount",
      "Due Date"
    "in_process": 0,
    "assigned_to": null,
    "outbound_skill_based_routing": {
      "enabled": false,
      "skill_list": null

Response Variables

The response returned is as following:

Variable NameDescriptionData Type
idUnique ID of the broadcast listInteger
nameName of the broadcastString
descriptionDescription Related to broadcast.String
sensitive_field_mapNumber of fields mapped with the list that are sensitive.String
field_mapNumber of fields mapped with the list.String
in_processWhether the status of the list is active or inactive. For example: PROCESS_ACTIVE => 1, self:: PROCESS_INACTIVE => 0Integer
assigned_toReturns the ID of broadcast on which this list is assigned to.Integer
outbound_skill_based_routing.enabledWhether skill list is mapped against the lead list or not.Boolean.
outbound_skill_based_routing.skill_listReturn the ID and name of the skill list.String.
count_idCount of leads associated with the list.Integer
Click Try It! to start a request and see the response here!