For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
13.5kProductPricingSign inStart free trialBook a demo
DocsAPIsSDKsEnterprise EdgeGuidesAcademyRelease notes
DocsAPIsSDKsEnterprise EdgeGuidesAcademyRelease notes
    • API overview
  • Client API
  • Frontend API
  • Admin API
      • GETValidate signup token
      • POSTAdd a user via a signup token
      • GETGet public signup tokens
      • POSTCreate a public signup token
      • GETRetrieve a token
      • PUTUpdate a public signup token

Unleash reduces the risk of releasing new features, drives innovation by streamlining the software release process, and increases revenue by optimizing end-user experience. While we serve the needs of the world's largest, most security-conscious organizations, we are also rated the “Easiest Feature Management system to use” by G2.

GitHubGitHubLinkedInLinkedInX (Twitter)X (Twitter)SlackSlackStack OverflowStack OverflowYouTubeYouTube

Server SDKs

  • Node.js
  • Java
  • Go
  • Rust
  • Ruby
  • Python
  • .NET
  • PHP
  • All SDKs

Frontend SDKs

  • JavaScript
  • React
  • Next.js
  • Vue
  • iOS
  • Android
  • Flutter

Feature Flag use cases

  • Secure, scalable feature flags
  • Rollbacks
  • FedRAMP, SOC2, ISO2700 compliance
  • Progressive or gradual rollouts
  • Trunk-based development
  • Software kill switches
  • A/B testing
  • Feature management
  • Canary releases

Product

  • Quickstart
  • Unleash architecture
  • Pricing
  • Product vision
  • Open live demo
  • Open source
  • Enterprise feature management platform
  • Unleash vs LaunchDarkly

Support

  • Help center
  • Status
  • Changelog
Made in a cosy atmosphere in the Nordic countries.Copyright © 2026 Unleash
LogoLogo
13.5kProductPricingSign inStart free trialBook a demo
Admin APIPublic signup tokens

Create a public signup token

||View as Markdown|
POST
https://app.unleash-instance.example.com/api/admin/invite-link/tokens
POST
/api/admin/invite-link/tokens
$curl -X POST https://app.unleash-instance.example.com/api/admin/invite-link/tokens \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "string",
>  "expiresAt": "2024-01-15T09:30:00Z"
>}'
1{
2  "secret": "a3c84b25409ea8ca1782ef17f94a42fc",
3  "url": "https://sandbox.getunleash.io/enterprise/new-user?invite=a3c84b25409ea8ca1782ef17f94a42fc",
4  "name": "Invite public viewers",
5  "enabled": true,
6  "expiresAt": "2023-04-12T11:13:31.960Z",
7  "createdAt": "2023-04-12T11:13:31.960Z",
8  "createdBy": "someone@example.com",
9  "role": {
10    "id": 9,
11    "type": "root",
12    "name": "Editor",
13    "description": "Users with the editor role have access to most features in Unleash but can not manage users and roles in the global scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default.",
14    "project": "default"
15  },
16  "users": [
17    {
18      "id": 123,
19      "name": "User",
20      "email": "user@example.com",
21      "username": "hunter",
22      "imageUrl": "https://example.com/242x200.png",
23      "inviteLink": "http://localhost:4242/invite-link/some-secret",
24      "loginAttempts": 3,
25      "emailSent": false,
26      "rootRole": 1,
27      "seenAt": "2023-06-30T11:42:00.345Z",
28      "createdAt": "2023-06-30T11:41:00.123Z",
29      "accountType": "User",
30      "permissions": [
31        "string"
32      ],
33      "scimId": "01HTMEXAMPLESCIMID7SWWGHN6",
34      "seatType": "Regular",
35      "companyRole": "Developer",
36      "productUpdatesEmailConsent": false,
37      "activeSessions": 2,
38      "deletedSessions": 1
39    }
40  ]
41}

Lets administrators create a invite link to share with colleagues. People that join using the public invite are assigned the Viewer role

Was this page helpful?
Previous

Retrieve a token

Next
Built with

Authentication

Authorizationstring
API key needed to access this API
OR
AuthorizationBearer
API key needed to access this API, in Bearer token format

Request

publicSignupTokenCreateSchema
namestringRequired
The token's name.
expiresAtstringRequiredformat: "date-time"
The token's expiration date.

Response headers

locationstring
The location of the newly created resource.

Response

The resource was successfully created.
secretstring
The actual value of the token. This is the part that is used by Unleash to create an invite link
urlstring or null
The public signup link for the token. Users who follow this link will be taken to a signup page where they can create an Unleash user.
namestring
The token's name. Only for displaying in the UI
enabledboolean

Whether the token is active. This property will always be false for a token that has expired.

expiresAtstringformat: "date-time"
The time when the token will expire.
createdAtstringformat: "date-time"
When the token was created.
createdBystring or null
The creator's email or username
roleobject
Users who sign up using this token will be given this role.
userslist of objects or null
Array of users that have signed up using the token.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error