List Invites
curl --request GET \
--url https://api.vertracloud.app/v1/workspaces/{id}/invitesimport requests
url = "https://api.vertracloud.app/v1/workspaces/{id}/invites"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vertracloud.app/v1/workspaces/{id}/invites', 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/{id}/invites",
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/{id}/invites"
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/{id}/invites")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vertracloud.app/v1/workspaces/{id}/invites")
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": [
{
"id": "<string>",
"workspace_id": "<string>",
"kind": {},
"email": {},
"role_id": "<string>",
"role_name": "<string>",
"invited_by": {},
"expires_at": "<string>",
"accepted_at": {},
"revoked_at": {},
"uses": 123,
"max_uses": {},
"expires_in_days": {},
"created_at": "<string>"
}
]
}Invites
List Invites
Lists pending and past invites. Requires members:manage; an API key needs the workspaces:invites scope.
GET
/
v1
/
workspaces
/
{id}
/
invites
List Invites
curl --request GET \
--url https://api.vertracloud.app/v1/workspaces/{id}/invitesimport requests
url = "https://api.vertracloud.app/v1/workspaces/{id}/invites"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vertracloud.app/v1/workspaces/{id}/invites', 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/{id}/invites",
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/{id}/invites"
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/{id}/invites")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vertracloud.app/v1/workspaces/{id}/invites")
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": [
{
"id": "<string>",
"workspace_id": "<string>",
"kind": {},
"email": {},
"role_id": "<string>",
"role_name": "<string>",
"invited_by": {},
"expires_at": "<string>",
"accepted_at": {},
"revoked_at": {},
"uses": 123,
"max_uses": {},
"expires_in_days": {},
"created_at": "<string>"
}
]
}An API key needs the
workspaces:invites scope (only in the full preset or a custom
selection). Creating invites stays dashboard-only.members:manage permission.
Path
string
required
Workspace ID.
Response
APIWorkspaceInvite[]
Show Toggle object
Show Toggle object
string
string
'email' | 'link'
string | null
Set only for
kind: \"email\".string
string
object
{ id, display_name }.string
7 days from creation for email invites, fixed 24h for link invites.
string | null
string | null
number
number | null
Only for
kind: \"link\"; null = unlimited.number | null
Access expiry applied to the member once they join through this invite.
null = no expiry.string
Errors
| Status | Code | When |
|---|---|---|
| 403 | API_KEY_SCOPE_DENIED | Called with an API key that lacks the workspaces:invites scope. |
| 403 | WORKSPACE_PERMISSION_DENIED | Caller lacks members:manage. |
| 404 | WORKSPACE_NOT_FOUND | Workspace doesn’t exist or you’re not a member. |