Fetch list of groups

Sample Request

curl --request GET \
     --url https://api.servetel.in/v1/contact/groups \
     --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 all the contact groups.

Variable Name	Description	Data Type
contact_group_id	Unique ID of the contact group.	string
updated_after	Time when the contact group was last updated.	string
limit	Number of records to be fetched. Min:1 and Max:100.	string
page	Page number of the record to be fetched.	string

Sample Response

{
  "page": 1,
  "size": 7,
  "limit": 10,
  "results": [
    {
      "id": 3148,
      "name": "Nikunj Manual Dialing Tas",
      "list_id": null,
      "description": "Nikunj Manual Dialing Tas",
      "field_map": [
        "Phone Number",
        "Name",
        "Email Id",
        "Address",
        "Company Name"
      ],
      "added_by": 10959,
      "created_by": 10959,
      "clone_from_contact": 0,
      "created_at": "2021-05-15T12:50:14+0530",
      "updated_at": "2021-05-15T12:50:14+0530",
      "deleted_at": null,
      "visible_to": null
    }, ......
  ]
}

Response Variables

The response returned is as following:

Variable Name	Description	Data Type
page	Index of the page.	Integer
size	Size of the record.	Integer
limit	Number of records fetched.	Integer
results[].id	Unique ID of the contact group.	String
results[].name	Name of the contact group.	String
results[].description	Description of the contact group.	String
results[].field_map	Fields that are being mapped against each contact.	Array
results[].added_by	User ID who added the contacts.	Integer
results[].created_by	User ID who created the contact group.	Integer
results[].clone_from_contact	Whether it is cloned from any other contact or not.	Integer
results[].created_at	Time stamp when it was created.	String
results[].updated_at	Time stamp when it was last updated.	String
results[].deleted_at	Time stamp when it was deleted from the records, if deleted.	String
results[].visible_to	IDs of the team members to whom the contact group is visible.	Array