Preview Invite
curl --request GET \
--url https://api.vertracloud.app/v1/workspaces/invites/{token}import requests
url = "https://api.vertracloud.app/v1/workspaces/invites/{token}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vertracloud.app/v1/workspaces/invites/{token}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vertracloud.app/v1/workspaces/invites/{token}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vertracloud.app/v1/workspaces/invites/{token}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vertracloud.app/v1/workspaces/invites/{token}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vertracloud.app/v1/workspaces/invites/{token}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"response": {
"workspace": {},
"inviter": {},
"role_name": "<string>",
"kind": {},
"expires_at": "<string>"
}
}Invites
Preview Invite
Shows what an invite leads to, before accepting. Any logged-in account; an API key needs the workspaces:invites scope.
GET
/
v1
/
workspaces
/
invites
/
{token}
Preview Invite
curl --request GET \
--url https://api.vertracloud.app/v1/workspaces/invites/{token}import requests
url = "https://api.vertracloud.app/v1/workspaces/invites/{token}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vertracloud.app/v1/workspaces/invites/{token}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vertracloud.app/v1/workspaces/invites/{token}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vertracloud.app/v1/workspaces/invites/{token}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vertracloud.app/v1/workspaces/invites/{token}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vertracloud.app/v1/workspaces/invites/{token}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"response": {
"workspace": {},
"inviter": {},
"role_name": "<string>",
"kind": {},
"expires_at": "<string>"
}
}An API key needs the
workspaces:invites scope. Rate-limited at 10 requests per
minute, keyed by session + IP together — the token is guessable in theory (32 random bytes,
but still a bearer secret in the URL), so this route gets a tighter bucket than the rest of
/v1/workspaces.410 WORKSPACE_INVITE_EXPIRED means the invite existed and its time ran out — 404 WORKSPACE_INVITE_NOT_FOUND covers revoked, already accepted, and exhausted (max_uses link),
because those three should read differently to whoever’s holding the link than “you’re too
late.”Path
string
required
The invite token from the URL/e-mail. Opaque, 16–128 characters.
Response
APIWorkspaceInvitePreview
Errors
| Status | Code | When |
|---|---|---|
| 403 | API_KEY_SCOPE_DENIED | Called with an API key that lacks the workspaces:invites scope. |
| 404 | WORKSPACE_INVITE_NOT_FOUND | Token doesn’t exist, or the invite was revoked, accepted or exhausted. |
| 410 | WORKSPACE_INVITE_EXPIRED | Invite existed but its expiry has passed. |