List Contact Groups

Display all contact groups with search and pagination support.

GET{{base_url}}/contact-groups

Query Parameters

Parameter	Type	Required	Description	Default
`page`	integer	No	Page number	`1`
`limit`	integer	No	Number of results per page	`10`
`searchTerm`	string	No	Search in group names	-

Tip: Use the searchTerm parameter for quick search in group names.

Example Request

Example Requestbash

curl -X GET "{{base_url}}/contact-groups?page=1&limit=10&searchTerm=Customers" \
-H "Accept: application/json" \
-H "X-Awal-Signature-256: sha256=abc..." \
-H "X-Timestamp: 1704124800" \
-H "X-Domain: your-workspace" \
-H "X-Client-ID: your-client-id"

Example Response

Response200 OK

{
"status": true,
"data": [
  {
    "id": 1,
    "name": "Customers",
    "status": 1,
    "contacts_count": 25,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T14:30:00Z"
  },
  {
    "id": 2,
    "name": "Suppliers",
    "status": 1,
    "contacts_count": 10,
    "created_at": "2024-01-16T11:00:00Z",
    "updated_at": "2024-01-18T09:15:00Z"
  }
],
"meta": {
  "current_page": 1,
  "per_page": 10,
  "total": 5,
  "last_page": 1
}
}

← Back to Contact Groups

View Guide

List Contact Groups

List Contact Groups

Query Parameters

Example Request

Example Response

Related