To search for and retrieve multiple Environments at once, use a GET with the Search API found at our API Explorer.
On our Cloud service, this API is available via SSL secured HTTPS connection using the REST GET, POST and PUT verbs.
The format query string parameter controls the desired response format. Specify either XML or JSON.
/api/v2/company?format=xml/json
NOTE: This API endpoint implements pagination, and as such you must cater for this when you connect to our platform.
You can learn more about pagination in our API overview.
GET Request
The GET verb allows you to retrieve multiple Environments, identified by your unique MasterId.
The required and optional parameters for a GET call to the Environment Search API are outlined below.
| Parameter Name | Data Type | Required | Description |
| Format (Response Content Type) |
String | Yes | Specifies the desired format of the response. Must either JSON or XML. |
| MasterId | Integer | Yes | Your unique Enterprise Toolkit account identifier |
| IntegrationKey | String | Yes | Your unique integration key |
| Name | String |
No |
Enterprise Toolkit account name to search for |
| Status | String | No |
Search for Enterprise Toolkit account in status |
| PageNo | Integer | No | The page number from which to start reading results (0 based) |
| PageSize | Integer | No | The page size (number of rows) to return. Maximum allowable value is 250. |
GET Response
The data returned from an EnvironmentSearch GET is provided as follows:
Model Description
EnvironmentSearchResponse
| Field Name | Data Type | Description |
| Environments | Environments | The returned collection containing all the Environment objects |
| TotalRows |
Integer | The total number of Environments available for your request parameters |
| ResponseStatus | ResponseStatus |