GET / contacts

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

This endpoint is used to retrieve user's contacts.

The user can retrieve their contacts, including those in shared contact groups, 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 contacts list(Default :10) Optional
order string Specifies the order in which the data should be sorted. Use asc for ascending order and desc for descending order; the default is desc Optional
page integer The page number for paginated data Optional
group_id integer If the user sends a specific group_id, filter out the contacts of that group Optional

Sample Params and Response:

params

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

Success Response:

{
  "status": true,
  "message": "Contacts",
  "data": [
    {
      "id": 1,
      "group_name": "My Contact Group",
      "first_name": "Easify",
      "last_name": "App",
      "phone_number": "+1289434****",
      "email_address": "easify@easify.app",
      "company": "company",
      "additional_1": "one",
      "additional_2": "two",
      "additional_3": "three",
      "shared_contact": true,
      "created_at": "12-02-2024 03:34:30 AM",
      "updated_at": "12-02-2024 03:34:30 AM"
    }
  ],
  "links": {
    "first": "https://backend.easify.app/api/v2/contacts?page=1",
    "last": "https://backend.easify.app/api/v2/contacts?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "https://backend.easify.app/api/v2/contacts?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "active": false
      }
    ],
    "path": "hhttps://backend.easify.app/api/v2/contacts",
    "per_page": 3,
    "to": 1,
    "total": 1
  }
}
  • The shared_contact is a Boolean field that indicates whether the contact is in the main user's shared contact group.

Api Response Status

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/contacts',
    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;
pixel for linkedin