Title: Search Business Email and Enterprise Email Users Using the API  
PrimaryCategory: Business &amp; Enterprise Email  
Type: Informational  
Tags: api, email_search, business_email, enterprise_email, email_users, filters  
Source UI Terms: auth-userid, api-key, order-id, email, email-pattern, statuses, account-types, over-quota, page-no  
Source Reference: Search Business Email and Enterprise Email Users Using the API  

---

### Key Info:  
This API allows you to search for Business Email or Enterprise Email users based on specific criteria. Available filters include exact email address, regex pattern match on the email, account status, account type, and quota status. You must provide your reseller ID, API key, and order ID to authenticate and specify the relevant email order.

#### Parameters:

| Name           | Data Type | Required / Optional | Description                                                                                               |
|----------------|-----------|---------------------|-----------------------------------------------------------------------------------------------------------|
| auth-userid    | Integer   | Required            | Your Live Account Reseller Id                                                                             |
| api-key       | String    | Required            | An alphanumeric code used to authenticate API calls                                                      |
| order-id      | Integer   | Required            | Order ID of the relevant Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email, or Digital Certificate order |
| email         | String    | Optional            | Exact email address of the user                                                                           |
| email-pattern | String    | Optional            | Regex pattern to match email addresses                                                                    |
| statuses      | String    | Optional            | Status of email account; possible values: **active**, **suspended**, **pending_activation**               |
| account-types | String    | Optional            | Type of email account; possible values: **pop_with_autoresponder**, **pop_with_auto_responder**, **forward_only** |
| over-quota    | Boolean   | Optional            | Indicates if mailbox is over quota; values: **true** or **false**                                        |
| page-no       | Integer   | Optional            | Defaults to 1; max 200 records per page; use to paginate results (e.g., 2 for records 201-400)            |

### HTTP Method:  
GET

### Example Test URL Request:  
```
https://test.httpapi.com/api/mail/users/search.json?auth-userid=0&amp;api-key=keyℴ-id=0
```

### Response:  
The API returns detailed information on all email users matching the specified search filters.

---

### Summary:  
You can search for Business or Enterprise Email users via API by specifying filters such as email address, status, account type, and paging options. Required authentication and order details must be included.

---

### Evaluation Pairs:  

**Q:** What are the required parameters to search email users using the API?  
**A:** Required parameters are `auth-userid` (your reseller ID), `api-key` (your API key), and `order-id` (the relevant order ID).

**Q:** How can I filter the search results to show only active email accounts?  
**A:** Use the `statuses` parameter with the value `active` to filter for active email accounts.

**Q:** How many records can I get per page and how do I fetch subsequent pages?  
**A:** Each page contains up to 200 records. Use the `page-no` parameter to fetch subsequent pages, e.g., `page-no=2` to get records 201-400.

<p>When you want to search Business Email or Enterprise Email users using the API. This article explains available search filters, account status options, account types, pagination, and response details for matching email users.</p>
<div class="region region-content">
<div class="block block-core block-page-title-block" id="block-twostates-page-title">
<div class="content">
<div id="toc" style="display: block;">
<div id="toc_content">
<p> </p>
</div>
</div>
</div>
</div>
<div class="node__content clearfix">
<div class="layout layout--onecol">
<div class="layout__region layout__region--content">
<div class="clearfix text-formatted field field--name-body field--type-text-with-summary field--label-hidden field__item">
<h2><a name="heading_0"></a>Description</h2>
<p>Searches users based on the search criteria.</p>
<h2><a name="heading_1"></a>Parameters</h2>
<table class="codetable"><tbody><tr><th colspan="1" rowspan="1">Name</th><th colspan="1" rowspan="1">Data Type</th><th colspan="1" rowspan="1">Required / Optional</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">auth-userid</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Your Live Account Reseller Id</td></tr><tr><td colspan="1" rowspan="1">api-key</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">An alphanumeric code that can be used to authenticate your API calls</td></tr><tr><td colspan="1" rowspan="1">order-id</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order</td></tr><tr><td colspan="1" rowspan="1">email</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Optional</td><td colspan="1" rowspan="1">Email address of user</td></tr><tr><td colspan="1" rowspan="1">email-pattern</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Optional</td><td colspan="1" rowspan="1">Regex pattern of email address</td></tr><tr><td colspan="1" rowspan="1">statuses</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Optional</td><td colspan="1" rowspan="1">Status of email account. Values can be: <em>active</em>, <em>suspended</em> and <em>pending_activation</em>.</td></tr><tr><td colspan="1" rowspan="1">account-types</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Optional</td><td colspan="1" rowspan="1">Type of email account. Values can be: <em>pop_with_autoresponder, <em>pop_with_auto_responder</em> and <em>forward_only</em>.</em></td></tr><tr><td colspan="1" rowspan="1">over-quota</td><td colspan="1" rowspan="1">Boolean</td><td colspan="1" rowspan="1">Optional</td><td colspan="1" rowspan="1">Values can be: <em>true</em> or <em>false</em>.</td></tr><tr><td colspan="1" rowspan="1">page-no</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Optional</td><td colspan="1" rowspan="1">Default value is 1. Each page contains max 200 records. E.g. Pass 2 as value if you want to fetch 201-400 records.</td></tr></tbody></table>
<h2><a name="heading_2"></a>HTTP Method</h2>
<p>GET</p>
<h2><a name="heading_3"></a>Example Test URL Request</h2>
<p><code><br>  https://test.httpapi.com/api/mail/users/search.json?auth-userid=0&amp;api-key=key&amp;order-id=0<br> </code></p>
<h2><a name="heading_4"></a>Response</h2>
<p>Returns the details of the users matching the specified search criteria.</p>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to search Business Email or Enterprise Email users using the API. This article explains available search filters, account status options, account types, pagination, and response details for matching email users.

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Your Live Account Reseller Id
api-key	String	Required	An alphanumeric code that can be used to authenticate your API calls
order-id	Integer	Required	Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
email	String	Optional	Email address of user
email-pattern	String	Optional	Regex pattern of email address
statuses	String	Optional	Status of email account. Values can be: active, suspended and pending_activation.
account-types	String	Optional	Type of email account. Values can be: pop_with_autoresponder, pop_with_auto_responder* and forward_only.*
over-quota	Boolean	Optional	Values can be: true or false.
page-no	Integer	Optional	Default value is 1. Each page contains max 200 records. E.g. Pass 2 as value if you want to fetch 201-400 records.