ReferenceOrganizations
Get invite link
Get an invite link by its code. Public endpoint used by the invite acceptance page.
GET/api/v1/invite-links/{inviteLinkCode}
Authentication: personal access token. The spec defines an api_key security
scheme — send an Authorization: ApiKey <your-personal-access-token> header
(value format: ApiKey <your key>). A session_cookie scheme (connect.sid)
exists for browser sessions. Operations in this spec declare security: [], an
artifact of the upstream spec generator — authentication is still enforced by the
server.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
inviteLinkCode | string | Yes | the code of the invite link |
Responses
200 — Success
{
"results": {
"purpose": "member",
"email": "string",
"userUuid": "string",
"organizationUuid": "string",
"inviteUrl": "string",
"inviteCode": "string",
"expiresAt": "2024-01-01T00:00:00.000Z",
"authentication": {
"ssoProviders": [
"google"
],
"allowPasswordSignup": true,
"allowOneClickActivation": true
}
},
"status": "ok"
}default — Error
{
"error": {
"data": "string",
"message": "string",
"name": "string",
"statusCode": 0
},
"status": "error"
}