Last updated
November 12th, 2026

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, the developer documentation linked at the end has everything you need.

Where to Find It

Click your user picture at the top of the app, open your profile, and select the Developer tab.

Developer tab in WorkSights Personal Settings with Register app and the endpoint list

Register an App

An app is an OAuth client that lets your code call the API on your behalf.

  1. Select Register app.
  2. Give it a name. The name is for your reference only. It appears prefixed with your account name (for example, Your Company Custom App).
  3. 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 (localhost is the exception), and wildcards are allowed.
  4. Select Register app.

Your Client ID and Secret

Once the app is registered you 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 cannot view it again. Treat it like a password.

Together these authenticate your app when it connects to the API.

Try the API with a Test Token

If you want to explore the API first, select Copy test token. This gives you a temporary bearer token you can paste into Postman or curl to make requests as yourself, with no setup.

The test token is for testing only. It expires after a short time and does not refresh, so it is not 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 are building with an AI coding assistant, Copy agent prompt packages the setup into a single prompt. Hand it to your agent to scaffold the integration.

Go Deeper

The developer documentation has the full walkthrough: running the OAuth 2.1 authorization-code flow, getting and refreshing access tokens, and the complete API reference.

docs.worksights.ai