GET / contact-groups

Base URL: https://backend.easify.app/api/v2

This endpoint is used to retrieve user's contact groups.

The user can retrieve their contact groups, including shared contact groups, in the response,with a default pagination limit of 10 if no limit is specified.

There is a rate limit of 60 requests per minute. If you exceed this limit, you will receive a 429 Too Many Requests status, along with a message indicating when you can try again.

Authentication

The Easify API token used for authentication is passed in the header as a Bearer token, which can be obtained from the easify app under Settings > API Settings.

Headers

Authorization string required Bearer << YOUR_EASIFY_API_TOKEN_HERE >>

Query Parameters

limit integer Pagination for contact groups list(Default :10) Optional
order string Specifies the order in which the data should be sorted. Use asc for ascending order and desc fordescending order; the default is desc Optional
page integer The page number for paginated data Optional

Sample Params and Response:

params

{
  "page": 2,
  "limit": 1,
  "order": "asc"
}

Success Response:

{
  "status": true,
  "message": "Contact Groups",
  "data": [
    {
      "id": 1,
      "name": "Group 1",
      "contacts_count": 0,
      "shared_group": false,
      "default_group": false,
      "created_at": "09-05-2024 07:27:18 AM"
    }
  ],
  "links": {
    "first": "https://backend.easify.app/api/v2/contact-groups?page=1",
    "last": "https://backend.easify.app/api/v2/contact-groups?page=61",
    "prev": "https://backend.easify.app/api/v2/contact-groupss?page=1",
    "next": "hhttps://backend.easify.app/api/v2/contact-groups?page=3"
  },
  "meta": {
    "current_page": 2,
    "from": 3,
    "last_page": 61,
    "links": [
      {
        "url": "hhttps://backend.easify.app/api/v2/contact-groups?page=1",
        "label": "&laquo; Previous",
        "active": false
      }
    ],
    "path": "https://backend.easify.app/api/v2/contact-groups",
    "per_page": 1,
    "to": 4,
    "total": 122
  }
}
  • The contacts_count in the response refers to the total number of contacts in the specific contact group.
  • The shared_group is a Boolean field that specifies whether the contact group is the main user's shared contact group or not.
  • The default_group is a Boolean field that indicates whether the contact group is the user's default contact group in the Easify app

Responses

Case Status Code Response
If the user does not provide a token in the header or provides an invalid token 401 { "status":false, "message": "Unauthenticated", "errors": [] }
If the user exceeds the allowed rate limit for requests 429 { "status":false, "message":"Too many requests. Try again in 59 seconds", "errors":[] }
If the user's subscription has ended 402 { "status":false,"message":"You need to recharge your account to proceed","errors":[] }
If the user does not have an enterprise plan 403 { "status": false, "message": "Access denied. Your current plan does not allow access to this feature. Please upgrade to the Enterprise plan.", "errors": [] }

PHP-cURL

<?php
$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://backend.easify.app/api/v2/contact-groups?order=asc',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer 1955|43da5bb5-5c2b-4059-a4de-d44bf5c****'
    ],
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;