| API Endpoint |
| https://secure.iforms.africa:443/api/v2/company/search |
To search for and retrieve multiple Companies at once, use a GET with the search API found at:
| Node | URL |
| US | https://secure.iforms.africa/apiexplorer#!/company/getv2companysearch |
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.
CONTENTS
- GET Request
- GET Response
- API Usage Example
GET Request
The GET verb allows you to retrieve multiple Companies identified by your unique VendorId.
The required (numbered) and optional parameters for a GET call to the Company Search API are outlined below.
By default, all paginated APIs start at PageNo of 0, which is the first page (i.e. the slice) of the result set.
After clicking "Try it out!" the GET Request URL will display for integration use in your systems.
Also, the Response Body, Code and Headers will be visible in the Response Content Type specified (JSON/XML).
GET Response
The data returned from a CompanySearch GET is provided as follows:
API Usage Example
Given that the API is REST-based, you can access the API directly via your web browser to test it. Obviously, for actual integration work, you will need to make a web request to the given REST URL and then parse the response.
When integrating with your system, the format query string parameter controls the desired response format. Specify either XML or JSON.
/api/v2/company/search?format=xml/json
Below are simple GET examples which get a list of Companies.
Generic
GET Request URL
https://secure.iforms.africa:443/api/v2/company/search?VendorId=51XXX&IntegrationKey=XXXXXX032af240fdb642218afbXXXXXX&&&&GET Request URL (XML)
GET Request URL (JSON)
