Personal access tokens (PATs)

Overview

Personal access tokens (PATs) let you authenticate to the Kompass API from scripts, integrations, and tools without using your password. Each token is tied to your user account and inherits your permissions.

Creating a token requires the Personal access tokens permission. Listing tokens also requires the view permission, and revoking one requires the delete permission. Signing in alone does not grant these.

Creating a token

  1. Sign in to Kompass and open Settings from your user menu.
  2. Choose API Tokens in the Settings navigation.
  3. Click Create.
  4. Give the token a recognizable name (for example SugarCRM sync) and optionally a description.
  5. Pick a Valid until date. It defaults to one year from today, must be in the future and cannot be more than a year away. A token cannot be created without one.
  6. Choose the Scopes: Read and Write are both selected by default, and a token needs at least one.
  7. Click Create.

The token value is shown once immediately after creation, with a Copy button. Copy it now and store it somewhere safe (a password manager or a secrets store). Kompass never shows the full value again; click Done when you have copied it.

Using a token

Include the token in the Authorization  header of every API request:

Authorization: Bearer <your-token>

This works with both the public Kompass API and the Kompass CLI (set KOMPASS_TOKEN ).

Managing tokens

The API Tokens page lists your tokens with their scopes, created date, last-used date and expiry date. A token expiring within 30 days shows its expiry date in yellow; an expired token shows a red Expired label.

To revoke a token, click Revoke next to it and confirm. The token stops working immediately. Any script using it starts receiving 401 responses.

Security

  • Treat tokens like passwords. Anyone with a token can act as you via the API.
  • Use a different token per integration so you can revoke one without breaking the others.
  • Tokens are not tied to your password; changing your password does not invalidate them. Revoke a token if you suspect it has leaked.
  • Tokens respect the same permission checks as the Kompass interface.
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us