Fetch list of groups

This API allows you to fetch all the contact 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 NameDescriptionData Type
contact_group_idUnique ID of the contact group.string
updated_afterTime when the contact group was last updated.string
limitNumber of records to be fetched. Min:1 and Max:100.string
pagePage 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",
        "Email Id",
        "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 NameDescriptionData Type
pageIndex of the page.Integer
sizeSize of the record.Integer
limitNumber of records fetched.Integer
results[].idUnique ID of the contact group.String
results[].nameName of the contact group.String
results[].descriptionDescription of the contact group.String
results[].field_mapFields that are being mapped against each contact.Array
results[].added_byUser ID who added the contacts.Integer
results[].created_byUser ID who created the contact group.Integer
results[].clone_from_contactWhether it is cloned from any other contact or not.Integer
results[].created_atTime stamp when it was created.String
results[].updated_atTime stamp when it was last updated.String
results[].deleted_atTime stamp when it was deleted from the records, if deleted.String
results[].visible_toIDs of the team members to whom the contact group is visible.Array
Click Try It! to start a request and see the response here!