Getting Started
The Workast API is organized around REST. We have predictable resource oriented URLs and we use standard HTTP response codes, authentication, and verbs. We accept json-encoded bodies and return json-encoded responses.
Along each endpoint you will find our Playground to test our the methods. You can authenticate yourself using your own Workast token or you can create an API token with more restricted scopes
This API powers all our clients (web, mobile and integrations) so you can build confidently that are all methods here have been tested and are working.
Authentication
The Workast API uses tokens to authenticate requests. All requests must include an authentication token and must be performed over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
To generate a token for your account, follow these steps:
- Open the Workast web application and login - E.g. acme.workast.com
- You will need to be in a paid account or you can start a trial
- Click on your name, in the top right corner of the web application.
- Click on Preferences
- In the new modal that opens, click on the API section.
- From here you can generate a new API token. If you have created one before, the previous one will be terminated.
- You can now use this token to authenticate here and try out the API
Make sure to keep your API token safe as any actions will be performed on behalf of your account.