GET api/Mail/Service?domain_handle={domain_handle}&domain_name={domain_name}&active={active}&user={user}

Request Information

URI Parameters

Name	Description	Type	Additional information
domain_handle	Optional domain handle	string	None.
domain_name	Optional domain name	string	None.
active	Optional flag to return active or inactive services only	boolean	None.
user	Optional user handle - if empty logged in user will be used	string	None.

Body Parameters

None.

Response Information

Resource Description

A list of mail service objects on success
Collection of errors on failure
Return codes
200 - ok
400 - bad request
401 - unauthorized
404 - not found
500 - internal server error

Collection of Service

Name	Description	Type	Additional information
handle	Service handle	string	None.
domain_handle	Domain handle	string	None.
name	Service name	string	None.
parent_handle	Handle of parent object if exists	string	None.
parent_type	Type of parent object if exists	string	None.
max_mail	Maximum mail boxes allowed	integer	None.
available_mail	No of mailboxes available	integer	None.
used_mail	No of mailboxes in use	integer	None.
expires_at	Expiry date	date	None.
AutoRenew	Has auto renew	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "handle": "sample string 1",
    "domain_handle": "sample string 2",
    "name": "sample string 3",
    "parent_handle": "sample string 4",
    "parent_type": "sample string 5",
    "max_mail": 6,
    "available_mail": 7,
    "used_mail": 8,
    "expires_at": "2025-12-12T19:15:50.1262403+01:00",
    "AutoRenew": true
  },
  {
    "handle": "sample string 1",
    "domain_handle": "sample string 2",
    "name": "sample string 3",
    "parent_handle": "sample string 4",
    "parent_type": "sample string 5",
    "max_mail": 6,
    "available_mail": 7,
    "used_mail": 8,
    "expires_at": "2025-12-12T19:15:50.1262403+01:00",
    "AutoRenew": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfService xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models">
  <Service>
    <AutoRenew>true</AutoRenew>
    <available_mail>7</available_mail>
    <domain_handle>sample string 2</domain_handle>
    <expires_at>2025-12-12T19:15:50.1262403+01:00</expires_at>
    <handle>sample string 1</handle>
    <max_mail>6</max_mail>
    <name>sample string 3</name>
    <parent_handle>sample string 4</parent_handle>
    <parent_type>sample string 5</parent_type>
    <used_mail>8</used_mail>
  </Service>
  <Service>
    <AutoRenew>true</AutoRenew>
    <available_mail>7</available_mail>
    <domain_handle>sample string 2</domain_handle>
    <expires_at>2025-12-12T19:15:50.1262403+01:00</expires_at>
    <handle>sample string 1</handle>
    <max_mail>6</max_mail>
    <name>sample string 3</name>
    <parent_handle>sample string 4</parent_handle>
    <parent_type>sample string 5</parent_type>
    <used_mail>8</used_mail>
  </Service>
</ArrayOfService>