get https://api.servetel.in/v1/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 Name | Description | Data Type |
|---|---|---|
| contact_id | Unique id of the contact. | string |
| contact_group_id | Unique id of the contact group. | string |
| updated_after | Time when it was last updated in the records. | string |
| limit | Number of records to be fetched. | string |
| page | Page 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 Name | Description | Data Type |
|---|---|---|
| page | Index of the page. | Integer. |
| size | Size of the record. | |
| limit | Number of records fetched. | Integer |
| results[].id | Unique ID of the contact. | String |
| results[].contact_group_id | Unique ID of the contact group. | String |
| results[].contact_group_name | Name of the contact group. | String |
| results[].phone_number | Phone number of the contact in the contact group. | String |
| results[].name | Name of the contact. | String |
| results[].email_id | Email ID of the contact. | String |
| results[].address | Address of the contact. | String |
| results[].company_name | Company Name of the contact. | String |
| results[].custom_fields[] | If any, custom field is mapped with the contact in the contact group. | Object |
| 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 |