Preview organization invitation

Returns invitation preview details so a user can inspect an organization invite before accepting it.

GET /v1/orgs/invitations/preview

Preview organization invitation

cURL

curl --request GET \
  --url https://api.example.com/v1/orgs/invitations/preview

import requests

url = "https://api.example.com/v1/orgs/invitations/preview"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/v1/orgs/invitations/preview', 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/v1/orgs/invitations/preview",
  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.example.com/v1/orgs/invitations/preview"

	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.example.com/v1/orgs/invitations/preview")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/orgs/invitations/preview")

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

200

{
  "invitation": {
    "id": "<string>",
    "email": "[e-mail]",
    "role": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "organization": {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "allowedEmailDomains": [
      "<string>"
    ],
    "branding": {
      "appName": "<string>",
      "logoUrl": "<string>",
      "iconUrl": "<string>"
    }
  }
}

{
  "error": "<string>",
  "details": [
    {
      "message": "<string>",
      "path": [
        "<string>"
      ]
    }
  ]
}

{
  "error": "<string>",
  "message": "<string>"
}

Query Parameters

id · string · required

Required string length: 1 - 255

Response

200

application/json

Invitation preview returned successfully.

invitation · object · required

Show child attributes

organization · object · required

Show child attributes