GET / email/senders
Base URL: https://backend.easify.app/api/v2
This endpoint is used to retrieve user's email senders.
The user can retrieve their active and verified email senders 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 >>
Request Body
limit integer | Pagination for phone numbers list (Default :10) | Optional |
page integer | Specific page number for paginated data | Optional |
Sample Params and Success Response:
params
{
"limit": 10
}
Success Response:
{
"status": true,
"message": "Email Senders",
"data": [
{
"id": 266,
"from_email": "test@easify.com",
"from_name": "Test Name",
"signature": "",
"footer": ""
}
],
"links": {
"first": "https://backend.easify.app/api/v2/email/senders?page=1",
"last": "https://backend.easify.app/api/v2/email/senders?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/email/senders?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "https://backend.easify.app/api/v2/email/senders",
"per_page": 1,
"to": 1,
"total": 1
}
}
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 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": []
}
|
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":[]
}
|
PHP-cURL
php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://backend.easify.app/api/v2/email/senders',
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 => array(
'Authorization: Bearer <> '
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;