Table of contents
Getting started with the WorkSights API
WorkSights includes a REST API so you or your development team can connect your team-activity data to your own tools and workflows. The Developer tab is where you set up secure access. This guide covers the essentials - for the full build, we link you to our developer documentation in the end.
Where to find it
Click on your user picture, open your profile from the top of the app and select the Developer tab.
Register an app
An app is an OAuth client that lets your code call the API on your behalf.
- Select Register app
- Give it a name. This is just for your reference, and you will see it prefixed with your account name (for example, Your Company Custom App)
- Add one or more redirect URIs. These are the addresses a user is allowed to return to after they approve access. They must use HTTPS (with the exception of localhost), and you can use wildcards.
- Select Register app.
Your Client ID and Secret
Once the app is registered you’ll get two values:
- Client ID - always available in the Developer tab.
- Client secret - shown once, right after you register. Copy it straight away and store it somewhere safe; you won’t be able to see it again. Treat it like a password.
Together these authenticate your app when it connects to the API.
Try the API quickly with a test token
If you just want to poke at the API, select Copy test token. This gives you a temporary bearer token you can paste into Postman or curl to make requests as yourself without setup.
The test token is for testing only. It expires after a short time and doesn’t refresh, so it isn’t suitable for a real integration.
Build an integration
The Endpoints & agent kit section gives you everything you need to build: the OAuth authorization, token, and discovery endpoints, plus the API base and spec.
If you’re building with an AI coding assistant, Copy agent prompt packages the setup into a single prompt you can hand straight to your agent to scaffold the integration.
Go deeper
For the full walkthrough on running the OAuth 2.1 authorization-code flow, getting and refreshing access tokens, and the complete API reference head to our developer documentation: