Accept an invitation (create account or join with existing session)

Public token route, IP rate limited (429). If the invited email already has an account, the caller MUST already be logged in as that exact account (else 401 requiresLogin / 403 mismatch). If no account exists, a password (min 8) in the body creates the account and logs in (Set-Cookie). systemRole is always USER — never read from the body.

Parameters

Path Parameters

token

required

string

Request Body

Required only for the no-existing-account path.

application/json

object

password

Required only when no account exists for the invited email

string

>= 8 characters

Example^generated

1
{
2
  "password": "example"
3
}

Responses

200

Accepted (existing-account path)

application/json

object

boolean

tenantId

string

role

string

Allowed values: ADMIN MEMBER

400

Password too short (no-account path)

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

401

Must log in as the invited account first

application/json

object

error

string

requiresLogin

boolean

Example

1
{
2
  "requiresLogin": true
3
}

403

Logged-in account email does not match invite

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

404

Invitation not found

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

409

Invitation used/revoked

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

410

Invitation expired

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

429

Rate limited

application/json

object

error

required

string

retryAfterSeconds

integer

Example^generated

1
{
2
  "error": "example",
3
  "retryAfterSeconds": 1
4
}

500

Session secret missing / create failed

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

POST

/api/auth/invitations/{token}

1
curl --request POST \
2
  --url https://retidal.com/api/auth/invitations/%3Cstring%3E \
3
  --header 'Content-Type: application/json' \
4
  --data '{
5
  "password": "<string>"
6
}'

1
const url = 'https://retidal.com/api/auth/invitations/%3Cstring%3E';
2
const options = {
3
  method: 'POST',
4
  headers: {'Content-Type': 'application/json'},
5
  body: '{"password":"<string>"}'
6
};
7

8
try {
9
  const response = await fetch(url, options);
10
  const data = await response.json();
11
  console.log(data);
12
} catch (error) {
13
  console.error(error);
14
}

1
import requests
2

3
url = "https://retidal.com/api/auth/invitations/%3Cstring%3E"
4

5
payload = { "password": "<string>" }
6
headers = {"Content-Type": "application/json"}
7

8
response = requests.post(url, json=payload, headers=headers)
9

10
print(response.json())

1
import httpx
2
import json
3

4
url = "https://retidal.com/api/auth/invitations/%3Cstring%3E"
5

6
payload = json.loads("{\n  \"password\": \"<string>\"\n}")
7

8
response = httpx.post(url, json=payload)
9

10
print(response.json())

1
package main
2

3
import (
4
  "fmt"
5
  "strings"
6
  "net/http"
7
  "io"
8
)
9

10
func main() {
11

12
  url := "https://retidal.com/api/auth/invitations/%3Cstring%3E"
13

14
  payload := strings.NewReader("{\n  \"password\": \"<string>\"\n}")
15

16
  req, _ := http.NewRequest("POST", url, payload)
17

18
  req.Header.Add("Content-Type", "application/json")
19

20
  res, _ := http.DefaultClient.Do(req)
21

22
  defer res.Body.Close()
23
  body, _ := io.ReadAll(res.Body)
24

25
  fmt.Println(res)
26
  fmt.Println(string(body))
27

28
}

200Accepted (existing-account path)

1
{
2
  "ok": true,
3
  "role": "ADMIN"
4
}

Accept an invitation (create account or join with existing session)

Parameters

Path Parameters

Request Body

Examplegenerated

Responses

200

400

Examplegenerated

401

Example

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

410

Examplegenerated

429

Examplegenerated

500

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated