API Endpoints
US Node – https://www.taskform.nl:443/api/v2/user
EU Node – https://dashboard.taskform.io:443/api/v2/user
AU Node – https://dashboard.taskform.nl:443/api/v2/user
The GET User Details API allows you to retrieve details of the user matching the given parameters.
On our Cloud service, this API is available via SSL-secured HTTPS connection using the REST GET, POST, PUT and DELETE verbs.
To retrieve details of a specific user, our API requires that you utilise the associated GUID of the user, which is returned in the “Id” parameter in the GET User (Search) part of our API.
TABLE OF CONTENTS
GET Request
You may use either JSON or XML formats in your request. You indicate this by setting the ContentType HTTP header as “application/json” or “application/xml”. If no ContentType is specified, XML format is assumed.
The format query string parameter controls the desired response format. Specify either XML or JSON.
/api/v2/screen/form?format=xml/json
***NOTE***
In order to query a user’s details, you will need the user’s GUID ID as returned from the GET User (Search) API call shown below:
When you use the User ID GUID, you can use the API to retrieve a user’s details as shown in the screenshot below:
GET Response
Below is the response from the GET request, showing details of the user specified.
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.
The format query string parameter controls the desired response format. Specify either XML or JSON.
To search for and retrieve multiple Users at once, use a GET with the search API found at:
/api/v2/user/search?format=xml/json
Below is a simple GET example which gets a User using XML format.
GET Request XML
https://dashboard.taskform.io:443/api/v2/user?Id=930XXXXXXXXXXXXXXXXXXXXXXXXXXXXX&CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXXXXX?format=xml
XML Response
<UserSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <TotalRows>3</TotalRows> <Users> <User> <CompanyId>6XXX</CompanyId> <Country>ZA</Country> <CreatedDate>2021-03-16T09:03:31.937Z</CreatedDate> <Email>XXXXXXX@XXXXXXXXXX.com</Email> <FirstName>System</FirstName> <Folders/> <Groups/> <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</Id> <LastActivity>1990-01-01T00:00:01Z</LastActivity> <LastName>Support</LastName> <LastUpdated>2022-09-20T11:27:34.543Z</LastUpdated> <Status>Invited</Status> <TimeZone>South Africa Standard Time</TimeZone> <TimeZoneOffSet>120</TimeZoneOffSet> <Type>Premium</Type> <UserDevices/> </User>