Fetch list of all contacts

This API allows you to fetch the list of all contacts in contact group.

Sample Request

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

Variable NameDescriptionData Type
contact_idUnique id of the contact.string
contact_group_idUnique id of the contact group.string
updated_afterTime when it was last updated in the records.string
limitNumber of records to be fetched.string
pagePage number of the record.string

Sample Response

  "page": 1,
  "size": 9,
  "limit": 10,
  "results": [
      "id": 19534897,
      "contact_group_id": 473,
      "contact_group_name": "Customers",
      "phone_number": "+987654321",
      "name": "Test",
      "email_id": "[email protected]",
      "address": "Test Address",
      "company_name": "Test Company",
      "custom_fields": [],
      "created_at": "2023-08-08T07:58:05+0000",
      "updated_at": "2023-08-08T07:58:05+0000",
      "deleted_at": null

Response Variables

The response returned is as following:

Variable NameDescriptionData Type
pageIndex of the page.Integer.
sizeSize of the record.
limitNumber of records fetched.Integer
results[].idUnique ID of the contact.String
results[].contact_group_idUnique ID of the contact group.String
results[].contact_group_nameName of the contact group.String
results[].phone_numberPhone number of the contact in the contact group.String
results[].nameName of the contact.String
results[].email_idEmail ID of the contact.String
results[].addressAddress of the contact.String
results[].company_nameCompany Name of the contact.String
results[].custom_fields[]If any, custom field is mapped with the contact in the contact group.Object
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
Click Try It! to start a request and see the response here!