• WorkTrail API
• Register App
• Libraries / Implementations
• Authorization & Scopes
• Request Basics
• Company
• Employees
• Tasks & Projects
• Work Entries
• WorkTrail Hub

• WorkTrail API /
• Request Basics

Request Basics

Every request you send to WorkTrail's API backend has a couple of requirements. These are only documented here. All requests are POST requests with URLs below https://worktrail.net/rest/*

Authorization

Every request has to include 1.) Your App Identifier, 2.) Your secret API Key and 3.) an auth token which authorizes your app to access data from a specific company. These can be either passed in as HTTP header (preferred) or as POST parameters.

• HTTP Headers: X-APPKEY, X-SECRETAPIKEY, X-AUTHTOKEN
• POST Parameters: appkey=xxx&secretapikey=xxx&authtoken=xxx

In all successful calls you will receive back a JSON object.

Data Types

Lists

URLs which return a list of objects - for example the list of employees, tasks or projects will be paged if there are too many objects. So if you want to synchronize all tasks you have to page through an entire list.

{
    "list": [
        { ... },
        { ... },
    ], 
    "num_pages": 1, 
    "page": 1
}

If the list contains more items than are allowed per page, you have to send more requests adding a GET parameter to the URL called "page". So to send a second request ?page=2 than ?page=3 etc.

All objects will contain a "modifydate" property which can be used for synchronizing incremental changes. After the initial sync, always remember the biggest value of "modifydate" from all objects you have read. On your next sync simply include the get parameter "after".

Example