Skip to main content
GET
/
organizations
/
{organizationID}
/
invitations
/
{invitationID}
Get details of a specific invitation
curl --request GET \
  --url https://api.xata.tech/organizations/{organizationID}/invitations/{invitationID} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.xata.tech/organizations/{organizationID}/invitations/{invitationID}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.xata.tech/organizations/{organizationID}/invitations/{invitationID}', 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.xata.tech/organizations/{organizationID}/invitations/{invitationID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$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.xata.tech/organizations/{organizationID}/invitations/{invitationID}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

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.xata.tech/organizations/{organizationID}/invitations/{invitationID}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.xata.tech/organizations/{organizationID}/invitations/{invitationID}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "organization_id": "<string>",
  "email": "jsmith@example.com",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "first_name": "<string>",
  "last_name": "<string>",
  "invite_link": "<string>"
}
{
"message": "<string>",
"id": "<string>"
}
{
"message": "invalid API key"
}
{
"message": "invalid API key"
}
{
"message": "<string>",
"id": "<string>"
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

organizationID
string
required

Unique identifier for a specific organization

Pattern: [a-zA-Z0-9_-~:]+
invitationID
string
required

Unique identifier for an invitation

Response

Invitation details retrieved successfully

id
string
required

Unique identifier for the invitation

organization_id
string
required

ID of the organization the invitation is for

Pattern: [a-zA-Z0-9_-~:]+
email
string<email>
required

Email address of the invited user

created_at
string<date-time>
required

Timestamp when the invitation was created

expires_at
string<date-time>
required

Timestamp when the invitation expires

status
enum<string>
required

Current status of the invitation

Available options:
pending,
expired
first_name
string | null

First name of the invited user

last_name
string | null

Last name of the invited user

URL link to accept the invitation