List Invitations
curl --request GET \
--url https://api.example.com/api/auth/organizations/invitations \
--header 'X-Organization-Id: <x-organization-id>'import requests
url = "https://api.example.com/api/auth/organizations/invitations"
headers = {"X-Organization-Id": "<x-organization-id>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Organization-Id': '<x-organization-id>'}};
fetch('https://api.example.com/api/auth/organizations/invitations', 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.example.com/api/auth/organizations/invitations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Organization-Id: <x-organization-id>"
],
]);
$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.example.com/api/auth/organizations/invitations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Organization-Id", "<x-organization-id>")
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.example.com/api/auth/organizations/invitations")
.header("X-Organization-Id", "<x-organization-id>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/auth/organizations/invitations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Organization-Id"] = '<x-organization-id>'
response = http.request(request)
puts response.read_body{
"invitations": [
{
"invite_id": "inv_xyz789",
"email": "newuser@example.com",
"client_id": "org_abc123",
"role": "user",
"invited_by": "user_def456",
"status": "pending",
"created_at": "2024-03-01T12:00:00Z",
"expires_at": "2024-03-08T12:00:00Z"
}
]
}
Organizations
List Invitations
GET
/
api
/
auth
/
organizations
/
invitations
List Invitations
curl --request GET \
--url https://api.example.com/api/auth/organizations/invitations \
--header 'X-Organization-Id: <x-organization-id>'import requests
url = "https://api.example.com/api/auth/organizations/invitations"
headers = {"X-Organization-Id": "<x-organization-id>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Organization-Id': '<x-organization-id>'}};
fetch('https://api.example.com/api/auth/organizations/invitations', 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.example.com/api/auth/organizations/invitations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Organization-Id: <x-organization-id>"
],
]);
$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.example.com/api/auth/organizations/invitations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Organization-Id", "<x-organization-id>")
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.example.com/api/auth/organizations/invitations")
.header("X-Organization-Id", "<x-organization-id>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/auth/organizations/invitations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Organization-Id"] = '<x-organization-id>'
response = http.request(request)
puts response.read_body{
"invitations": [
{
"invite_id": "inv_xyz789",
"email": "newuser@example.com",
"client_id": "org_abc123",
"role": "user",
"invited_by": "user_def456",
"status": "pending",
"created_at": "2024-03-01T12:00:00Z",
"expires_at": "2024-03-08T12:00:00Z"
}
]
}
Retrieve a list of all pending invitations for your organization.
Request
string
required
The unique identifier of the organization.
Response
array
List of invitation objects for the organization.
Show Invitation Object
Show Invitation Object
string
The unique identifier for the invitation.
string
The email address that the invitation was sent to.
string
The organization ID associated with the invitation.
string
The role assigned to the invitation.
string
The user ID of the person who created the invitation.
string
The status of the invitation (e.g.,
pending, accepted, cancelled).string
The timestamp when the invitation was created.
string
The timestamp when the invitation will expire.
{
"invitations": [
{
"invite_id": "inv_xyz789",
"email": "newuser@example.com",
"client_id": "org_abc123",
"role": "user",
"invited_by": "user_def456",
"status": "pending",
"created_at": "2024-03-01T12:00:00Z",
"expires_at": "2024-03-08T12:00:00Z"
}
]
}
⌘I