To search and retrieve an Environment account, use a GET with the Environment 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 a single Environment, identified by its unique CompanyId.
The required and optional parameters for a GET call to the Environment 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. |
| CompanyId | Integer | Yes | The other Enterprise Toolkit account’s unique identifier |
| IntegrationKey | String | Yes | Your Enterprise Toolkit account’s unique integration key |
| MasterId |
Integer | Yes |
Your Enterprise Toolkit account’s unique identifier |
GET Response
The data returned from an Environment GET is provided as follows:
Model Description
EnvironmentResponse
| Field Name | Data Type | Description |
| Environment | Environments | The returned collection containing all the Environment objects |
| ResponseStatus | ResponseStatus |
Details of any errors that may have occurred |
Environment
| Field Name | Data Type |
Description |
| Id |
Integer |
Unique Environment Id (Company Id) found on the Organisation Setup page>Integrations Settings of the secure website. |
| Name |
String (Max 100 chars) |
Environment name |
| Description |
String (Max 300 chars) |
A description of the Environment. |
| Country | String | The country to which this Environment belongs. |
| TimeZone | String |
The Environment’s default time zone. e.g. Pacific Standard Time |
| TimeZoneOffSet | Integer |
The value the timezone is offset by. |
| DateFormat | String |
The Environment’s date display format. Examples include:
|
| TimeFormat | String |
The Environment’s time display format. Examples include:
|
| FillRepeatRows | Boolean (true/false) |
Whether or not to copy down repeatable answer values when exporting repeatable data to tabular formats like CSV |
| SendInviteEmailsTo |
String |
Instructs the system to send all user invite and reset emails to the given email address |
| DefaultSenderEmail |
String |
The email address to use as the default for emails sent from the platform by this Enterprise Toolkit account |
| DefaultSenderName |
String |
The sender name to use as the default for emails sent from the platform by this Enterprise Toolkit account |
| GlobalFormRESTUrl |
String |
Returns the Global Forms REST URL set on the Environments Organisation Setup page>Integration Settings of the secure website. |
| GlobalTaskRESTUrl |