Title: Get Active Product Details Using the API
PrimaryCategory: API
Type: Informational
Tags: api, product_details, authentication, free_email_service
Source UI Terms: None
Source Reference: Get Active Product Details Using the API

Key Info:
This article explains how to retrieve details of active products using the API. It covers the required authentication parameters, HTTP method, example request format, and the structure of the product details returned. Additionally, if you offer a FREE Email Service, the API response will include its details as well.

Parameters:
| Name         | Data Type | Required / Optional | Description              |
|--------------|------------|---------------------|--------------------------|
| auth-userid  | Integer    | Required            | Authentication Parameter |
| api-key      | String     | Required            | Authentication Parameter |

HTTP Method:
GET

Example Test URL:
```
https://test.httpapi.com/api/products/details.json?auth-userid=0&amp;api-key=key
```

Response:
The API returns a map where each key is a productkey and its value is another map containing the details for that product. This includes details for the FREE Email Service product if your offerings include it.

Summary:
This article describes how to use a GET API call with authentication parameters to retrieve detailed information about your active products, including the FREE Email Service if available.

Evaluation Pairs:
Q: What authentication parameters are required to get active product details using the API?
A: You must provide both &#39;auth-userid&#39; (an integer) and &#39;api-key&#39; (a string) as required authentication parameters.

Q: What HTTP method should be used to retrieve active product details?
A: The GET method should be used.

Q: Does the API response include details for FREE Email Service products?
A: Yes, if you offer FREE Email Service, its details will also be included in the API response.

<p>When you want to retrieve the details of active products using the API. This article explains the required authentication parameters, API request format, product detail response structure, and FREE Email Service product information.</p>
<p> </p>
<div class="region region-content">
<div class="block block-core block-page-title-block" id="block-twostates-page-title">
<div class="content">
<h1 class="title page-title"><span class="field field--name-title field--type-string field--label-hidden">Get Details</span></h1>
<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>Gets the details of the active products.</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">Authentication Parameter</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">Authentication Parameter</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</h2>
<p><code>https://test.httpapi.com/api/products/details.json?auth-userid=0&amp;api-key=key</code></p>
<h2><a name="heading_4"></a>Response</h2>
<p>Returns a map with key as productkey and value as another map containing the details of the product corresponding to the product key. If you are offering FREE Email Service, this method will also return details related to it.</p>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to retrieve the details of active products using the API. This article explains the required authentication parameters, API request format, product detail response structure, and FREE Email Service product information.

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Authentication Parameter
api-key	String	Required	Authentication Parameter