Search Users
Home » Reseller Guides » Reseller API Guide » HTTP API » API Requests » Email Service Management » Email Accounts

Search Users

Description

Searches users based on the search criteria.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key or auth-password String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration 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.

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/mail/users/search.json?auth-userid=0&api-key;=key&order-id;=0

Response

Returns the details of the users matching the specified search criteria.