This request method allows you to find all companies that match specified criteria.
On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb.
The format query string parameter controls the desired response format. Specify either XML or JSON.
/api/v2/company/search?format=xml/json
You may use either JSON or XML formats in your GET submission.
You indicate this by setting the ContentType HTTP header as “application/json” or “application/xml”.
If no ContentType is specified, XML format is assumed.
All XML formatted requests must specify the following XML namespace in the data source root element:
xmlns:i=”http://www.w3.org/2001/XMLSchema-instance”
Endpoints & API Explorer
| Node | API Endpoint | API Explorer |
|---|---|---|
| US | /api/v2/company/search | Model Description/Schema & Parameters |
Parameters
The GET verb allows you to find all companies matching the given criteria.
The required and optional parameters for a GET call to the Task Recurring API are outlined below.
| Name | Type | Description | Required |
|---|---|---|---|
| Name | String | Company name to search for | |
| Status | String | Search for companies in status (Active/Retired) | |
| PageNo | Integer | The page number from which to start reading results (0 based) | |
| PageSize | Integer | The page size (number of rows) to return. Maximum allowable value is 250. | |
| VendorId | Integer | Your unique Vendor account identifier | ✓ |
| IntegrationKey | String | Your unique integration key | ✓ |
Example
Given that the API is REST-based, you can access the API directly via your web browser to test or by using Postman API Platform.
Request URL
https://eforms.mobileform.net/api/v2/company/search?VendorId=7XXXX&IntegrationKey=caXXXXXXXXXXXXXXXXXXXXXXXXXXXThis 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
Response Body
{
"Companies": [
{
"Id": 9XXXX,
"Name": "Client ETK",
"Description": "For Enterprise Toolkit testing purpose\r\n",
"Country": "AR",
"TimeZone": "Argentina Standard Time",
"TimeZoneOffSet": -180,
"DateFormat": "dd-MMM-yyyy",
"TimeFormat": "HH:mm",
"FillRepeatRows": true,
"RerouteResetEmails": false,
"Status": "Active",
"LastUpdated": "2025-06-27T17:53:21.1862730Z",
"LastUpdatedBy": "Godoy, Vanina",
"Created": "2025-04-28T13:42:39.6632330Z",
"CreatedBy": "Godoy, Vanina",
"ActiveDevices": 0,
"BillType": "Default",
"Metadata": [],
"IntegrationKey": "9XXXXXXXXXXXXXXXXXXXXXXXX",
"VendorId": 8XXXX
},
{
"Id": 8XXXX,
"Name": "Company Sheet",
"Description": "Test Connection DB Company",
"Country": "AR",
"TimeZone": "Argentina Standard Time",
"TimeZoneOffSet": -180,
"DateFormat": "dd-MMM-yyyy",
"TimeFormat": "HH:mm",
"FillRepeatRows": true,
"RerouteResetEmails": false,
"Status": "Active",
"LastUpdated": "2025-06-27T17:53:20.0449360Z",
"LastUpdatedBy": "Godoy, Vanina",
"Created": "2024-07-31T13:20:47.8803930Z",
"CreatedBy": "Godoy, Vanina",
"ActiveDevices": 0,
"BillType": "Default",
"Metadata": [],
"IntegrationKey": "bXXXXXXXXXXXXXXXXXXXXXXXXX",
"VendorId": 8XXXX
}
]
}