API Endpoints
US Node – https://www.taskform.nl:443/api/v2/screen/form/search
EU Node – https://dashboard.taskform.io:443/api/v2/screen/form/search
US Node – https://dashboard.taskform.nl:443/api/v2/screen/form/search
The Screen API returns the Published version of matching Forms or all versions of a single specified Form.
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 the published version of a Screen, use a GET with the screen API found at:
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 all versions of a published form or the published versions of matching forms.
The required parameters for a GET call to the Screen API are outlined below.
When logged into an account, Ids can be found on the Organisation Setup > Integrations page of the secure website.
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 Screen GET search 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 works, 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/screen/form/search?format=xml/json
Below are simple GET examples which get a Screen/Screens returned from the endpoint..
GET Request URL
https://dashboard.taskform.io:443/api/v2/screen/form/search?CompanyId=6XXXX&IntegrationKey=995dfXXXXXXXXXXXXXXXXXXXXXXXXXX
GET Request URL (XML)
https://dashboard.taskform.io:443/api/v2/screen/form/search?format=xml&CompanyId=6XXXX&IntegrationKey=995dfXXXXXXXXXXXXXXXXXXXXXXXXXX
GET Request URL (JSON)
https://dashboard.taskform.io:443/api/v2/screen/form/search?format=json&CompanyId=6XXXX&IntegrationKey=995dfXXXXXXXXXXXXXXXXXXXXXXXXXX