curl --request GET \
--url https://api-dev.narrative.io/v2/apps/{app_slug} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-dev.narrative.io/v2/apps/{app_slug}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-dev.narrative.io/v2/apps/{app_slug}', 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/v2/apps/{app_slug}",
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-dev.narrative.io/v2/apps/{app_slug}"
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-dev.narrative.io/v2/apps/{app_slug}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dev.narrative.io/v2/apps/{app_slug}")
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{
"type": "owned",
"id": 42,
"slug": "facebook_connector",
"status": "pending",
"manifest": {
"manifest_version": "1.0.0",
"display_name": "Facebook Connector",
"capabilities": [
"destination_connector"
],
"api_url": "https://facebook-connector.example.com/api",
"required_scopes": [
{
"resource": "datasets",
"access": "read"
}
],
"app_token_scopes": [
{
"resource": "datasets",
"access": "read"
}
],
"ui_url": "https://facebook-connector.example.com",
"launch_path": {
"type": "native",
"path": "connector-settings"
},
"embedding": {
"device_permissions": [
"<string>"
],
"initial_guest_path": "/"
},
"pages": [
{
"eligible_path": "connector-settings",
"navigation": {
"title": "Connector Settings",
"icon": "display-list",
"pill": "<string>",
"show_as_button": true,
"button_variant": "<string>"
},
"visible_path": "<string>"
}
],
"listing": {
"headlines": {
"tagline": "<string>",
"body": "<string>"
},
"short_description": "<string>",
"long_description": "<string>",
"meta_description": "<string>",
"icon": {
"name": "<string>",
"image": "<string>",
"image_type": "image/svg+xml",
"alt_text": "<string>",
"width": 123,
"height": 123
},
"headline_image": {
"name": "<string>",
"image": "<string>",
"image_type": "image/svg+xml",
"alt_text": "<string>",
"width": 123,
"height": 123
},
"background_color": "#E7E3CE",
"merchandising_sections": [
{
"title": "<string>",
"subtitle": "<string>",
"order": 123,
"image": {
"name": "<string>",
"image": "<string>",
"image_type": "image/svg+xml",
"alt_text": "<string>",
"width": 123,
"height": 123
}
}
],
"developer_information": {
"name": "<string>",
"website": "<string>",
"support_email": "<string>",
"privacy_policy": "<string>",
"support_website": "<string>"
},
"tags": [
"<string>"
]
}
},
"client_id": "85b558340b635861575c462a10df3bd5",
"created_at": "2026-09-24T17:21:03.120581",
"updated_at": "2026-09-24T17:21:03.120581"
}{
"error": "Unauthorized",
"error_description": "You are not authorized to use this endpoint."
}{
"error": "Unauthorized",
"error_description": "You are not authorized to use this endpoint."
}Get an app
Returns an app the caller can see: any active app, or one of the caller’s own pending apps. The owning company gets the owned form; every other company gets the shared form.
curl --request GET \
--url https://api-dev.narrative.io/v2/apps/{app_slug} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-dev.narrative.io/v2/apps/{app_slug}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-dev.narrative.io/v2/apps/{app_slug}', 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/v2/apps/{app_slug}",
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-dev.narrative.io/v2/apps/{app_slug}"
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-dev.narrative.io/v2/apps/{app_slug}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dev.narrative.io/v2/apps/{app_slug}")
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{
"type": "owned",
"id": 42,
"slug": "facebook_connector",
"status": "pending",
"manifest": {
"manifest_version": "1.0.0",
"display_name": "Facebook Connector",
"capabilities": [
"destination_connector"
],
"api_url": "https://facebook-connector.example.com/api",
"required_scopes": [
{
"resource": "datasets",
"access": "read"
}
],
"app_token_scopes": [
{
"resource": "datasets",
"access": "read"
}
],
"ui_url": "https://facebook-connector.example.com",
"launch_path": {
"type": "native",
"path": "connector-settings"
},
"embedding": {
"device_permissions": [
"<string>"
],
"initial_guest_path": "/"
},
"pages": [
{
"eligible_path": "connector-settings",
"navigation": {
"title": "Connector Settings",
"icon": "display-list",
"pill": "<string>",
"show_as_button": true,
"button_variant": "<string>"
},
"visible_path": "<string>"
}
],
"listing": {
"headlines": {
"tagline": "<string>",
"body": "<string>"
},
"short_description": "<string>",
"long_description": "<string>",
"meta_description": "<string>",
"icon": {
"name": "<string>",
"image": "<string>",
"image_type": "image/svg+xml",
"alt_text": "<string>",
"width": 123,
"height": 123
},
"headline_image": {
"name": "<string>",
"image": "<string>",
"image_type": "image/svg+xml",
"alt_text": "<string>",
"width": 123,
"height": 123
},
"background_color": "#E7E3CE",
"merchandising_sections": [
{
"title": "<string>",
"subtitle": "<string>",
"order": 123,
"image": {
"name": "<string>",
"image": "<string>",
"image_type": "image/svg+xml",
"alt_text": "<string>",
"width": 123,
"height": 123
}
}
],
"developer_information": {
"name": "<string>",
"website": "<string>",
"support_email": "<string>",
"privacy_policy": "<string>",
"support_website": "<string>"
},
"tags": [
"<string>"
]
}
},
"client_id": "85b558340b635861575c462a10df3bd5",
"created_at": "2026-09-24T17:21:03.120581",
"updated_at": "2026-09-24T17:21:03.120581"
}{
"error": "Unauthorized",
"error_description": "You are not authorized to use this endpoint."
}{
"error": "Unauthorized",
"error_description": "You are not authorized to use this endpoint."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The app's slug. The app's unique, permanent name: 1-256 lowercase letters, digits or underscores. Chosen at creation and never changes. Slugs are unique regardless of case, so a slug that differs from an existing one only by case is taken.
^[a-z0-9_]{1,256}$"facebook_connector"
Response
OK
- Option 1
- Option 2
An app as seen by the caller. The owning company gets the full app (type is owned); every other company
gets the shared form, without credentials or lifecycle fields.
owned The app's id. Installations refer to the app by it.
42
The app's unique, permanent name: 1-256 lowercase letters, digits or underscores. Chosen at creation and never changes. Slugs are unique regardless of case, so a slug that differs from an existing one only by case is taken.
^[a-z0-9_]{1,256}$"facebook_connector"
pending: visible to and installable by the owning company only.active: visible to and installable by every company.archived: visible to nobody.
pending, active, archived What the app is, what it can do, and how it is listed. Only manifest_version and display_name are required;
everything else may be left out while the app is pending. An active app must also fill the listing card:
short_description, long_description, icon, headline_image, background_color and
developer_information.
Show child attributes
Show child attributes
The app's OAuth client id, hex-encoded — the form POST /oauth/token accepts.
"85b558340b635861575c462a10df3bd5"
An ISO-8601 local date-time in UTC, without an offset.
"2026-09-24T17:21:03.120581"
An ISO-8601 local date-time in UTC, without an offset.
"2026-09-24T17:21:03.120581"
Was this page helpful?

