Create and manage personal API tokens
Create a personal access token for scripts and integrations, then extend, regenerate or revoke it from Profile › API Tokens.
- Applies to
- Core 12.0 and later
- Who can do this
- Developer, Administrator
- Where
- Account menu › API Tokens
On this page
A personal API token lets a script or another system call the Laramin API as you. Treat it like a password.
Before you start
- Your account needs API access. An administrator turns on Enable API Access for your user. Your account must also be active and have a verified email address.
- If API Tokens is missing from the account menu and the Profile hub, you don't have API access yet. Ask your administrator.
Create a token
-
In the header, select your avatar to open the account menu.
-
Select API Tokens.
-
Select New Token.

-
In Name, enter a name that says where the token is used, for example "CI pipeline". It must differ from the names of your other active tokens.
-
In Expiry, choose how long the token lasts: 30 Days, 60 Days, 90 Days, 180 Days, 365 Days or Custom. Your administrator may also allow Never Expires.
-
If you chose Custom, enter the number of days in Custom Days. It must be 1 or more.
-
Select Create Token.
-
In Your New API Token, select Copy. Store the token somewhere safe, such as a password manager.
-
Select Done.
Careful: Copy the token before you close the dialog. Laramin shows it only once and can't show it again.
New tokens carry the read scope. A read token can fetch data through the API, but can't change anything: a request that saves, changes or deletes data is refused with the error code INSUFFICIENT_.
A personal API token works on the mobile API addresses, /api/v1/mobile/…, including add-ons' addresses there. The web addresses, /api/v1/web/…, refuse it with 401. See Authenticate API requests.
Extend, regenerate or revoke a token
The list shows each token's Name, Created, Last Used, Expires and Status (Active, Expired or Revoked). The actions appear on active tokens.
- Extend Expiry: sets the token to expire a fixed number of days from today. The default is 90 days, and your administrator can change it. You see "Token expiry extended by … days."
- Regenerate: revokes the token and issues a new one with the same name. Confirm "Regenerate “…”? The old token will stop working immediately." Then copy the new token from Your New API Token.
- Revoke: stops the token working. Confirm "Revoke “…”? This cannot be undone."
Careful: Extend Expiry counts from today, not from the current expiry date. On a token that still has more time left than the default, it shortens the expiry.
What happens next
Use the token in your script or integration in place of a password. If a token leaks, revoke it straight away and create a new one.
Changing your password on the web, resetting it, or an administrator setting it stops every token you have. Create new tokens afterwards for your scripts and integrations.
Thanks. That helps us decide what to write next.
Thanks for telling us what was missing.
You already answered for this article today. Thanks.
We got a lot of answers from your network just now. Try again in a few minutes.
We couldn't send that. Check your connection and try again.
Links in this article
Printed from help.laramin.in. The online article may have changed since.