| API Endpoint |
| https://secure.iforms.africa:443/api/v2/company |
The Company API allows you to retrieve, create and delete client Companies on the platform.
This enables scenarios where Companies created/maintained in other systems (e.g. SAP, Salesforce) can be replicated to the platform automatically.
On our Cloud service, this API is available via SSL-secured HTTPS connection using the REST GET, POST and PUT verbs.
To search for and retrieve a Company, use a GET with the company API found at:
| Node | URL |
| US | https://secure.iforms.africa/apiexplorer#!/company/getv2company |
To search for and retrieve multiple Companys at once, use GET Companies.
Note, the search 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 a single Company, identified by its unique Company Id.
The required parameters for a GET call to the Company API are outlined below.
When logged into an account, Ids can be found on the Organisation Setup > Integrations page of the secure website, or a GET Companies API request.
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.
GET Response
The data returned from a Company 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?format=xml/json
Below are simple GET examples which get a Company.
GET Request URL
GET Request URL (XML)
GET Request URL (JSON)
