List pending invites for a tenant

Returns all pending invites for a given tenant, accessible by authenticated members of the tenant.

GET /v2/databases/{database}/tenants/{tenantId}/invites

List pending invites for a tenant

cURL

curl --request GET \
  --url https://api.example.com/v2/databases/{database}/tenants/{tenantId}/invites \
  --cookie nile-auth.session-token=

import requests

url = "https://api.example.com/v2/databases/{database}/tenants/{tenantId}/invites"

headers = {"cookie": "nile-auth.session-token="}

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

print(response.text)

const options = {method: 'GET', headers: {cookie: 'nile-auth.session-token='}};

fetch('https://api.example.com/v2/databases/{database}/tenants/{tenantId}/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.example.com/v2/databases/{database}/tenants/{tenantId}/invites",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_COOKIE => "nile-auth.session-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.example.com/v2/databases/{database}/tenants/{tenantId}/invites"

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

	req.Header.Add("cookie", "nile-auth.session-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.example.com/v2/databases/{database}/tenants/{tenantId}/invites")
  .header("cookie", "nile-auth.session-token=")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/databases/{database}/tenants/{tenantId}/invites")

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

request = Net::HTTP::Get.new(url)
request["cookie"] = 'nile-auth.session-token='

response = http.request(request)
puts response.read_body

200

[
  {
    "id": "bd371f92-03e1-4862-9f6b-6d96d392ff18",
    "tenant_id": "019731dc-2462-7615-8dc3-c9fd85e61966",
    "token": "0007afb8bf432f8729491e1af35f03d111eb9a8105c0e9c3eebd8ca31585aed3",
    "identifier": "[e-mail]",
    "roles": null,
    "created_by": "019731dc-2440-7fd2-88b6-b233cc0e2695",
    "expires": "2025-06-02T22:16:40.535Z"
  }
]

"<string>"

"<string>"

"<string>"

"<string>"

Authorizations

nile-auth.session-token · string · cookie · required

Session token stored in a cookie after user signs in, prefixed with __Secure if on https

Path Parameters

database · string · required

tenantId · string · required

Response

200

application/json

List of pending invites

id · string<uuid>

tenant_id · string<uuid>

token · string

Hashed invite token

identifier · string<email>

roles · string[] | null

created_by · string<uuid>

ID of the user who sent the invite

expires · string<date-time>