curl --request GET \
--url https://api-dev.narrative.io/app-invites/codes/{code}import requests
url = "https://api-dev.narrative.io/app-invites/codes/{code}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api-dev.narrative.io/app-invites/codes/{code}', 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-dev.narrative.io/app-invites/codes/{code}",
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-dev.narrative.io/app-invites/codes/{code}"
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-dev.narrative.io/app-invites/codes/{code}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dev.narrative.io/app-invites/codes/{code}")
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{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"app": {
"id": 100,
"name": "Test App",
"slug": "test-app"
},
"company": {
"id": 42,
"logo": "https://example.com/logo.png",
"name": "Acme Corp"
},
"data": {
"key": "value"
},
"display_name": "Partner onboarding invite",
"invitee_name": "Jane Smith",
"status": "pending",
"url": "https://example.com/invite?code=abc123def456ghi789jkl012"
}{
"error": "Unauthorized",
"error_description": "You are not authorized to use this endpoint."
}Get app invite by code
Returns a public view of an app invite by its invite code.
This endpoint does not require authentication and returns a stripped-down response that omits fields like timestamps and tags from the response.
curl --request GET \
--url https://api-dev.narrative.io/app-invites/codes/{code}import requests
url = "https://api-dev.narrative.io/app-invites/codes/{code}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api-dev.narrative.io/app-invites/codes/{code}', 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-dev.narrative.io/app-invites/codes/{code}",
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-dev.narrative.io/app-invites/codes/{code}"
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-dev.narrative.io/app-invites/codes/{code}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dev.narrative.io/app-invites/codes/{code}")
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{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"app": {
"id": 100,
"name": "Test App",
"slug": "test-app"
},
"company": {
"id": 42,
"logo": "https://example.com/logo.png",
"name": "Acme Corp"
},
"data": {
"key": "value"
},
"display_name": "Partner onboarding invite",
"invitee_name": "Jane Smith",
"status": "pending",
"url": "https://example.com/invite?code=abc123def456ghi789jkl012"
}{
"error": "Unauthorized",
"error_description": "You are not authorized to use this endpoint."
}Path Parameters
The invite code used to look up an app invite.
Response
Successfully retrieved the app invite.
A stripped-down public view of an app invite, returned for unauthenticated code lookups.
Unique identifier for the app invite.
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Summary information about an app.
Show child attributes
Show child attributes
{
"id": 100,
"name": "Test App",
"slug": "test-app"
}
Summary information about a company.
Show child attributes
Show child attributes
{
"id": 42,
"logo": "https://example.com/logo.png",
"name": "Acme Corp"
}
The lifecycle status of an app invite.
pending, active, archived "pending"
The full invite URL constructed from the base URL and invite code.
"https://example.com/invite?code=abc123def456ghi789jkl012"
Custom JSON data associated with the invite.
{ "key": "value" }
An optional display name for the invite.
"Partner onboarding invite"
An optional name for the invitee. Maximum 1024 characters.
"Jane Smith"
Was this page helpful?

