• Spring naar de hoofdnavigatie
  • Door naar de hoofd inhoud
  • Spring naar de voettekst

Taskform: De flexibele app voor uw bedrijfssoftware

|

023-2340999

|

info@taskform.nl

|

Knowledge Base

|

Remote Support

|

LOG IN

Logo Taskform

TaskForm

De flexibele mobiele app voor uw bedrijfssoftware

  • Home
  • Hoe werkt Taskform?
    • TaskForm Data Connector
    • TaskForm Appbuilder ™
    • Taakbeheer
  • Voorbeelden
    • Werkbon app
    • Werkplekinspectie app
    • Urenregistratie app
  • Referenties
    • Proteus apps
    • Factuursturen apps
  • Prijzen
  • Blog
Gratis Proberen

GET User (User Search)

Taskform > User API > GET User (User Search)
Welcome to our Knowledge Base

The Users API allows you to retrieve, create and delete Users on the platform. This enables scenarios, where users created/maintained in other systems (e.g. SAP, Salesforce), can be replicated through the platform automatically.

Node API Endpoint API Explorer
US https://www.taskform.nl:443/api/v2/user/search https://www.taskform.nl/apiexplorer#!/user/getv2usersearch
EU https://dashboard.taskform.io:443/api/v2/user/search https://dashboard.taskform.io/apiexplorer#!/user/getv2usersearch
AU https://dashboard.taskform.nl:443/api/v2/user/search https://dashboard.taskform.nl/apiexplorer#!/user/getv2usersearch

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 or a single User identified by name, email or an external ID.


The required (numbered) and optional parameters for a GET call to the User 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 User 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.


On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET, POST and DELETE verbs.
The format query string parameter controls the desired response format. Specify either XML or JSON.

/api/v2/user?format=xml/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   

/api/v2/user?email=test@somewhere.com&integrationkey=xxxxxxxxxxxx&companyid=1&format=xml

 XML Response       

<UserResponse>
<ResponseStatus>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
</ResponseError>
</Errors>
</ResponseStatus>
<User>
<CompanyId>0</CompanyId>
<Email>String</Email>
<ExternalId>String</ExternalId>
<FirstName>String</FirstName>
<Folders>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Folders>
<Groups>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Groups>
<Id>00000000-0000-0000-0000-000000000000</Id>
<IntegrationKey>String</IntegrationKey>
<LastActivity>0001-01-01T00:00:00</LastActivity>
<LastName>String</LastName>
<UserDevices>
<UserDevice>
<Hardware>String</Hardware>
<Id>00000000-0000-0000-0000-000000000000</Id>
<OS>String</OS>
<OSVersion>String</OSVersion>
</UserDevice>
</UserDevices>
<Status>String</Status>
<WebsiteRole>String</WebsiteRole>
</User>
</UserResponse>

       

Tags:
  • User API
Geïnteresseerd om gratis te proberen?

Laat uw gegevens achter en probeer onze app 30 dagen gratis.

Footer

Blog

  • Taskform wordt zelfstandig bedrijf en verwelkomt nieuwe directeur
  • Parijs Release: Innovatieve en Diverse Functies
  • Kopenhagen Update: Focus op Tijd Besparing
  • Berlijn update: Mobile app met OCR en Netsuite Koppeling
  • Roma update: Verbeter je apps

Support

Knowledge Base
Contact

Contact

info@taskform.nl
+31 023 2340 999

App store downloads

Download-Taskform-Android-app Download-Taskform-Apple-app