List mini apps
curl --request GET \
--url http://localhost:8080/mini-apps \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:8080/mini-apps"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:8080/mini-apps', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/mini-apps",
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 := "http://localhost:8080/mini-apps"
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("http://localhost:8080/mini-apps")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/mini-apps")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"mini_apps": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"can_edit": true,
"name": "<string>",
"description": "<string>",
"icon": "ChartBar",
"live_version": "<string>",
"draft_version_id": "<string>",
"target_surface": "inbox",
"preview_file_id": "<string>",
"tags": [
"<string>"
],
"owner": {
"id": 123,
"name": "<string>",
"avatar_url": "<string>"
},
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Mini-apps
List mini-apps
List the mini-apps the caller can see, newest-updated first, and find one by name, description, surface, or tag.
GET
/
mini-apps
List mini apps
curl --request GET \
--url http://localhost:8080/mini-apps \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:8080/mini-apps"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:8080/mini-apps', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/mini-apps",
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 := "http://localhost:8080/mini-apps"
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("http://localhost:8080/mini-apps")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/mini-apps")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"mini_apps": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"can_edit": true,
"name": "<string>",
"description": "<string>",
"icon": "ChartBar",
"live_version": "<string>",
"draft_version_id": "<string>",
"target_surface": "inbox",
"preview_file_id": "<string>",
"tags": [
"<string>"
],
"owner": {
"id": 123,
"name": "<string>",
"avatar_url": "<string>"
},
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Returns the apps newest-updated first, with each app’s name, description, tags,
surface, published version, draft, owner, and
Use the app’s
can_edit.
What the list contains depends on who is calling:
- An identified user with app read or write permission, or an admin, sees every app in the workspace, including apps that only have a draft.
- Any other identified user sees only published apps shared with one of their
roles.
draft_version_idis alwaysnullfor them. - A bare API key needs
mini-apps:read, sees every app, and receivescan_edit: false.
| Parameter | Matches |
|---|---|
q | Text in the app’s name or description, ignoring case |
surface | inbox or dashboard, the same value the app reports in target_surface |
tags | Apps with at least one of the tags, ignoring case. Repeat the parameter or separate tags with commas |
id with Read source to read
its code or check whether you can edit it.Authorizations
Query Parameters
Was this page helpful?