Skip to main content
GET
/
orgs
/
{org_id}
/
pages
List pages
curl --request GET \
  --url https://api.useinvent.com/orgs/{org_id}/pages \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.useinvent.com/orgs/{org_id}/pages"

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

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.useinvent.com/orgs/{org_id}/pages', 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.useinvent.com/orgs/{org_id}/pages",
  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.useinvent.com/orgs/{org_id}/pages"

	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.useinvent.com/orgs/{org_id}/pages")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.useinvent.com/orgs/{org_id}/pages")

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
[
  {
    "id": "page_5Fb7…",
    "slug": "store-overview",
    "title": "Store overview",
    "icon": "<string>",
    "parent_id": "<string>",
    "position": 123,
    "show_in_sidebar": true,
    "archived": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

​
org_id
string
required

The ID of the org

Query Parameters

​
search
string

Search pages by title or slug.

Maximum string length: 256
​
status
enum<string>

Filter by visibility. ACTIVE excludes archived (default), ARCHIVED returns only archived, ALL returns both.

Available options:
ACTIVE,
ARCHIVED,
ALL
​
page
number

Page number

​
take
number

Number of items to take

​
next
string

Next page token (Only used on special endpoints)

Response

200 - application/json
​
id
string
required
Example:

"page_5Fb7…"

​
slug
string
required

Friendly URL segment, unique per org.

Required string length: 1 - 64
Pattern: ^[a-z][a-z0-9-]{0,63}$
Example:

"store-overview"

​
title
string | null
required

Page title.

Required string length: 1 - 255
Example:

"Store overview"

​
icon
required

The emoji of a curated icon a user can pick for a table, view, field, or other entity

​
color
enum<string>
required

The name of the color to use in the UI

Available options:
red,
orange,
amber,
yellow,
lime,
green,
teal,
cyan,
sky,
blue,
indigo,
violet,
purple,
fuchsia,
pink,
rose,
neutral
​
parent_id
string | null
required

Parent page id. Reserved for nesting; unused by the UI.

​
position
integer
required

Sidebar-zone order.

​
show_in_sidebar
boolean
required
​
archived
boolean
required
​
created_at
string<date-time> | null
required
​
updated_at
string<date-time> | null
required