Read app content on main draft

curl --request GET \
  --url https://{instance}.omniapp.co/api/v2/documents/{documentId}/draft/app \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{instance}.omniapp.co/api/v2/documents/{documentId}/draft/app"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{instance}.omniapp.co/api/v2/documents/{documentId}/draft/app', 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://{instance}.omniapp.co/api/v2/documents/{documentId}/draft/app",
  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://{instance}.omniapp.co/api/v2/documents/{documentId}/draft/app"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://{instance}.omniapp.co/api/v2/documents/{documentId}/draft/app")

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

{
  "html": "<!doctype html><html><body><h1>Sales overview</h1></body></html>",
  "settings": {
    "allowClipboard": false,
    "allowDefaultMapProviders": false,
    "allowDownloads": false,
    "allowExternalNavigation": false,
    "allowInternalNavigation": false,
    "externalNavOpensInNewTab": true,
    "navAllowedDomains": [],
    "navAllowedDomainsEnabled": false,
    "safeDomains": [],
    "safeDomainsEnabled": false
  }
}

{
  "detail": "Unauthorized: Missing or invalid API key",
  "status": 401
}

{
  "detail": "<string>",
  "status": 403
}

{
  "detail": "<string>",
  "status": 404
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

GET

documents

{documentId}

draft

app

Read app content on main draft

curl --request GET \
  --url https://{instance}.omniapp.co/api/v2/documents/{documentId}/draft/app \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{instance}.omniapp.co/api/v2/documents/{documentId}/draft/app"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{instance}.omniapp.co/api/v2/documents/{documentId}/draft/app', 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://{instance}.omniapp.co/api/v2/documents/{documentId}/draft/app",
  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://{instance}.omniapp.co/api/v2/documents/{documentId}/draft/app"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://{instance}.omniapp.co/api/v2/documents/{documentId}/draft/app")

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

{
  "html": "<!doctype html><html><body><h1>Sales overview</h1></body></html>",
  "settings": {
    "allowClipboard": false,
    "allowDefaultMapProviders": false,
    "allowDownloads": false,
    "allowExternalNavigation": false,
    "allowInternalNavigation": false,
    "externalNavOpensInNewTab": true,
    "navAllowedDomains": [],
    "navAllowedDomainsEnabled": false,
    "safeDomains": [],
    "safeDomainsEnabled": false
  }
}

{
  "detail": "Unauthorized: Missing or invalid API key",
  "status": 401
}

{
  "detail": "<string>",
  "status": 403
}

{
  "detail": "<string>",
  "status": 404
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

Authorizations

Authorization

string

header

required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

documentId

string

required

Document identifier — either the URL slug (e.g. abc123) or the canonical workbook UUID.

Example:

"abc123"

Query Parameters

pretty

enum<string>

Set true or 1 to pretty-print (2-space indent) the response; false / 0 (the default) is compact. Key ordering is deterministic regardless.

Available options:

0,

1,

true,

false

Response

The main draft's app content.

The published app's HTML and sandbox settings.

html

string

required

The complete app HTML document.

settings

object

required

The app's sandbox settings. A write replaces the whole object; omitted fields use their locked-down defaults. Host lists are normalized (deduped, invalid or Omni-owned hosts dropped) before they are stored.

Show child attributes

Getting started

Who am I?

AI APIs

API token APIs

App APIs

Connection APIs

Content APIs

Dashboard APIs

Document APIs

Folder APIs

Label APIs

Model APIs

Query APIs

Schedule APIs

Upload APIs

User APIs

User group APIs

Read app content on main draft

Authorizations

Path Parameters

Query Parameters

Response