Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl --request POST \
--url http://localhost:3000/v2/object-views \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"icon": {
"emoji": "page_icon",
"domain": "acme.com",
"lucide": "file-text",
"brand": "github",
"empty": true,
"updatedBy": "dataset:empresas"
},
"position": 0,
"config": {
"fields": [
{
"fieldId": "<string>",
"visible": true,
"position": 123,
"size": 123
}
],
"filters": [
{
"id": "<string>",
"fieldId": "<string>",
"operator": "<string>",
"position": 123,
"value": "<string>"
}
],
"sorts": [
{
"id": "<string>",
"fieldId": "<string>",
"position": 123
}
],
"groupByFieldId": "<string>",
"rowGroupByFieldId": "<string>",
"groupOrder": [
"<string>"
],
"hiddenGroups": [
"<string>"
],
"display": {},
"description": "<string>"
}
}
'import requests
url = "http://localhost:3000/v2/object-views"
payload = {
"name": "<string>",
"icon": {
"emoji": "page_icon",
"domain": "acme.com",
"lucide": "file-text",
"brand": "github",
"empty": True,
"updatedBy": "dataset:empresas"
},
"position": 0,
"config": {
"fields": [
{
"fieldId": "<string>",
"visible": True,
"position": 123,
"size": 123
}
],
"filters": [
{
"id": "<string>",
"fieldId": "<string>",
"operator": "<string>",
"position": 123,
"value": "<string>"
}
],
"sorts": [
{
"id": "<string>",
"fieldId": "<string>",
"position": 123
}
],
"groupByFieldId": "<string>",
"rowGroupByFieldId": "<string>",
"groupOrder": ["<string>"],
"hiddenGroups": ["<string>"],
"display": {},
"description": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
icon: {
emoji: 'page_icon',
domain: 'acme.com',
lucide: 'file-text',
brand: 'github',
empty: true,
updatedBy: 'dataset:empresas'
},
position: 0,
config: {
fields: [{fieldId: '<string>', visible: true, position: 123, size: 123}],
filters: [
{
id: '<string>',
fieldId: '<string>',
operator: '<string>',
position: 123,
value: '<string>'
}
],
sorts: [{id: '<string>', fieldId: '<string>', position: 123}],
groupByFieldId: '<string>',
rowGroupByFieldId: '<string>',
groupOrder: ['<string>'],
hiddenGroups: ['<string>'],
display: {},
description: '<string>'
}
})
};
fetch('http://localhost:3000/v2/object-views', 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 => "3000",
CURLOPT_URL => "http://localhost:3000/v2/object-views",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'icon' => [
'emoji' => 'page_icon',
'domain' => 'acme.com',
'lucide' => 'file-text',
'brand' => 'github',
'empty' => true,
'updatedBy' => 'dataset:empresas'
],
'position' => 0,
'config' => [
'fields' => [
[
'fieldId' => '<string>',
'visible' => true,
'position' => 123,
'size' => 123
]
],
'filters' => [
[
'id' => '<string>',
'fieldId' => '<string>',
'operator' => '<string>',
'position' => 123,
'value' => '<string>'
]
],
'sorts' => [
[
'id' => '<string>',
'fieldId' => '<string>',
'position' => 123
]
],
'groupByFieldId' => '<string>',
'rowGroupByFieldId' => '<string>',
'groupOrder' => [
'<string>'
],
'hiddenGroups' => [
'<string>'
],
'display' => [
],
'description' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/v2/object-views"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"icon\": {\n \"emoji\": \"page_icon\",\n \"domain\": \"acme.com\",\n \"lucide\": \"file-text\",\n \"brand\": \"github\",\n \"empty\": true,\n \"updatedBy\": \"dataset:empresas\"\n },\n \"position\": 0,\n \"config\": {\n \"fields\": [\n {\n \"fieldId\": \"<string>\",\n \"visible\": true,\n \"position\": 123,\n \"size\": 123\n }\n ],\n \"filters\": [\n {\n \"id\": \"<string>\",\n \"fieldId\": \"<string>\",\n \"operator\": \"<string>\",\n \"position\": 123,\n \"value\": \"<string>\"\n }\n ],\n \"sorts\": [\n {\n \"id\": \"<string>\",\n \"fieldId\": \"<string>\",\n \"position\": 123\n }\n ],\n \"groupByFieldId\": \"<string>\",\n \"rowGroupByFieldId\": \"<string>\",\n \"groupOrder\": [\n \"<string>\"\n ],\n \"hiddenGroups\": [\n \"<string>\"\n ],\n \"display\": {},\n \"description\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/v2/object-views")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"icon\": {\n \"emoji\": \"page_icon\",\n \"domain\": \"acme.com\",\n \"lucide\": \"file-text\",\n \"brand\": \"github\",\n \"empty\": true,\n \"updatedBy\": \"dataset:empresas\"\n },\n \"position\": 0,\n \"config\": {\n \"fields\": [\n {\n \"fieldId\": \"<string>\",\n \"visible\": true,\n \"position\": 123,\n \"size\": 123\n }\n ],\n \"filters\": [\n {\n \"id\": \"<string>\",\n \"fieldId\": \"<string>\",\n \"operator\": \"<string>\",\n \"position\": 123,\n \"value\": \"<string>\"\n }\n ],\n \"sorts\": [\n {\n \"id\": \"<string>\",\n \"fieldId\": \"<string>\",\n \"position\": 123\n }\n ],\n \"groupByFieldId\": \"<string>\",\n \"rowGroupByFieldId\": \"<string>\",\n \"groupOrder\": [\n \"<string>\"\n ],\n \"hiddenGroups\": [\n \"<string>\"\n ],\n \"display\": {},\n \"description\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/object-views")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"icon\": {\n \"emoji\": \"page_icon\",\n \"domain\": \"acme.com\",\n \"lucide\": \"file-text\",\n \"brand\": \"github\",\n \"empty\": true,\n \"updatedBy\": \"dataset:empresas\"\n },\n \"position\": 0,\n \"config\": {\n \"fields\": [\n {\n \"fieldId\": \"<string>\",\n \"visible\": true,\n \"position\": 123,\n \"size\": 123\n }\n ],\n \"filters\": [\n {\n \"id\": \"<string>\",\n \"fieldId\": \"<string>\",\n \"operator\": \"<string>\",\n \"position\": 123,\n \"value\": \"<string>\"\n }\n ],\n \"sorts\": [\n {\n \"id\": \"<string>\",\n \"fieldId\": \"<string>\",\n \"position\": 123\n }\n ],\n \"groupByFieldId\": \"<string>\",\n \"rowGroupByFieldId\": \"<string>\",\n \"groupOrder\": [\n \"<string>\"\n ],\n \"hiddenGroups\": [\n \"<string>\"\n ],\n \"display\": {},\n \"description\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"object": "object_view",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"objectKind": "report",
"type": "board",
"name": "<string>",
"position": 123,
"locked": true,
"config": {
"fields": [
{
"fieldId": "<string>",
"visible": true,
"position": 123,
"size": 123
}
],
"filters": [
{
"id": "<string>",
"fieldId": "<string>",
"operator": "<string>",
"position": 123,
"value": "<string>"
}
],
"sorts": [
{
"id": "<string>",
"fieldId": "<string>",
"direction": "asc",
"position": 123
}
],
"groupByFieldId": "<string>",
"rowGroupByFieldId": "<string>",
"groupOrder": [
"<string>"
],
"hiddenGroups": [
"<string>"
],
"display": {},
"description": "<string>"
},
"icon": {
"type": "emoji",
"emoji": "page_icon",
"external": {
"url": "https://example.com/image.jpg"
},
"file_upload": {
"id": "fu_abc123"
},
"domain": "acme.com",
"file": {
"url": "https://s3.amazonaws.com/...",
"expiryTime": "2024-01-15T10:30:00.000Z"
},
"lucide": "file-text",
"brand": "github",
"dicebear": {
"style": "notionists-neutral",
"seed": "0256de50-f90c-49a8-81f0-3988b2b89d8d",
"backgroundColor": "b6e3f4,b6e3f4",
"options": {
"brows": "<string>",
"eyes": "<string>",
"glasses": "<string>",
"lips": "<string>",
"nose": "<string>",
"flip": true,
"rotate": 123,
"scale": 123,
"radius": 123,
"size": 123,
"backgroundType": "solid",
"backgroundRotation": [
123
],
"translateX": 123,
"translateY": 123,
"clip": true,
"randomizeIds": true
}
},
"background": "blue",
"empty": true,
"updatedBy": "dataset:empresas"
}
}curl --request POST \
--url http://localhost:3000/v2/object-views \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"icon": {
"emoji": "page_icon",
"domain": "acme.com",
"lucide": "file-text",
"brand": "github",
"empty": true,
"updatedBy": "dataset:empresas"
},
"position": 0,
"config": {
"fields": [
{
"fieldId": "<string>",
"visible": true,
"position": 123,
"size": 123
}
],
"filters": [
{
"id": "<string>",
"fieldId": "<string>",
"operator": "<string>",
"position": 123,
"value": "<string>"
}
],
"sorts": [
{
"id": "<string>",
"fieldId": "<string>",
"position": 123
}
],
"groupByFieldId": "<string>",
"rowGroupByFieldId": "<string>",
"groupOrder": [
"<string>"
],
"hiddenGroups": [
"<string>"
],
"display": {},
"description": "<string>"
}
}
'import requests
url = "http://localhost:3000/v2/object-views"
payload = {
"name": "<string>",
"icon": {
"emoji": "page_icon",
"domain": "acme.com",
"lucide": "file-text",
"brand": "github",
"empty": True,
"updatedBy": "dataset:empresas"
},
"position": 0,
"config": {
"fields": [
{
"fieldId": "<string>",
"visible": True,
"position": 123,
"size": 123
}
],
"filters": [
{
"id": "<string>",
"fieldId": "<string>",
"operator": "<string>",
"position": 123,
"value": "<string>"
}
],
"sorts": [
{
"id": "<string>",
"fieldId": "<string>",
"position": 123
}
],
"groupByFieldId": "<string>",
"rowGroupByFieldId": "<string>",
"groupOrder": ["<string>"],
"hiddenGroups": ["<string>"],
"display": {},
"description": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
icon: {
emoji: 'page_icon',
domain: 'acme.com',
lucide: 'file-text',
brand: 'github',
empty: true,
updatedBy: 'dataset:empresas'
},
position: 0,
config: {
fields: [{fieldId: '<string>', visible: true, position: 123, size: 123}],
filters: [
{
id: '<string>',
fieldId: '<string>',
operator: '<string>',
position: 123,
value: '<string>'
}
],
sorts: [{id: '<string>', fieldId: '<string>', position: 123}],
groupByFieldId: '<string>',
rowGroupByFieldId: '<string>',
groupOrder: ['<string>'],
hiddenGroups: ['<string>'],
display: {},
description: '<string>'
}
})
};
fetch('http://localhost:3000/v2/object-views', 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 => "3000",
CURLOPT_URL => "http://localhost:3000/v2/object-views",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'icon' => [
'emoji' => 'page_icon',
'domain' => 'acme.com',
'lucide' => 'file-text',
'brand' => 'github',
'empty' => true,
'updatedBy' => 'dataset:empresas'
],
'position' => 0,
'config' => [
'fields' => [
[
'fieldId' => '<string>',
'visible' => true,
'position' => 123,
'size' => 123
]
],
'filters' => [
[
'id' => '<string>',
'fieldId' => '<string>',
'operator' => '<string>',
'position' => 123,
'value' => '<string>'
]
],
'sorts' => [
[
'id' => '<string>',
'fieldId' => '<string>',
'position' => 123
]
],
'groupByFieldId' => '<string>',
'rowGroupByFieldId' => '<string>',
'groupOrder' => [
'<string>'
],
'hiddenGroups' => [
'<string>'
],
'display' => [
],
'description' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/v2/object-views"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"icon\": {\n \"emoji\": \"page_icon\",\n \"domain\": \"acme.com\",\n \"lucide\": \"file-text\",\n \"brand\": \"github\",\n \"empty\": true,\n \"updatedBy\": \"dataset:empresas\"\n },\n \"position\": 0,\n \"config\": {\n \"fields\": [\n {\n \"fieldId\": \"<string>\",\n \"visible\": true,\n \"position\": 123,\n \"size\": 123\n }\n ],\n \"filters\": [\n {\n \"id\": \"<string>\",\n \"fieldId\": \"<string>\",\n \"operator\": \"<string>\",\n \"position\": 123,\n \"value\": \"<string>\"\n }\n ],\n \"sorts\": [\n {\n \"id\": \"<string>\",\n \"fieldId\": \"<string>\",\n \"position\": 123\n }\n ],\n \"groupByFieldId\": \"<string>\",\n \"rowGroupByFieldId\": \"<string>\",\n \"groupOrder\": [\n \"<string>\"\n ],\n \"hiddenGroups\": [\n \"<string>\"\n ],\n \"display\": {},\n \"description\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/v2/object-views")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"icon\": {\n \"emoji\": \"page_icon\",\n \"domain\": \"acme.com\",\n \"lucide\": \"file-text\",\n \"brand\": \"github\",\n \"empty\": true,\n \"updatedBy\": \"dataset:empresas\"\n },\n \"position\": 0,\n \"config\": {\n \"fields\": [\n {\n \"fieldId\": \"<string>\",\n \"visible\": true,\n \"position\": 123,\n \"size\": 123\n }\n ],\n \"filters\": [\n {\n \"id\": \"<string>\",\n \"fieldId\": \"<string>\",\n \"operator\": \"<string>\",\n \"position\": 123,\n \"value\": \"<string>\"\n }\n ],\n \"sorts\": [\n {\n \"id\": \"<string>\",\n \"fieldId\": \"<string>\",\n \"position\": 123\n }\n ],\n \"groupByFieldId\": \"<string>\",\n \"rowGroupByFieldId\": \"<string>\",\n \"groupOrder\": [\n \"<string>\"\n ],\n \"hiddenGroups\": [\n \"<string>\"\n ],\n \"display\": {},\n \"description\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/object-views")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"icon\": {\n \"emoji\": \"page_icon\",\n \"domain\": \"acme.com\",\n \"lucide\": \"file-text\",\n \"brand\": \"github\",\n \"empty\": true,\n \"updatedBy\": \"dataset:empresas\"\n },\n \"position\": 0,\n \"config\": {\n \"fields\": [\n {\n \"fieldId\": \"<string>\",\n \"visible\": true,\n \"position\": 123,\n \"size\": 123\n }\n ],\n \"filters\": [\n {\n \"id\": \"<string>\",\n \"fieldId\": \"<string>\",\n \"operator\": \"<string>\",\n \"position\": 123,\n \"value\": \"<string>\"\n }\n ],\n \"sorts\": [\n {\n \"id\": \"<string>\",\n \"fieldId\": \"<string>\",\n \"position\": 123\n }\n ],\n \"groupByFieldId\": \"<string>\",\n \"rowGroupByFieldId\": \"<string>\",\n \"groupOrder\": [\n \"<string>\"\n ],\n \"hiddenGroups\": [\n \"<string>\"\n ],\n \"display\": {},\n \"description\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"object": "object_view",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"objectKind": "report",
"type": "board",
"name": "<string>",
"position": 123,
"locked": true,
"config": {
"fields": [
{
"fieldId": "<string>",
"visible": true,
"position": 123,
"size": 123
}
],
"filters": [
{
"id": "<string>",
"fieldId": "<string>",
"operator": "<string>",
"position": 123,
"value": "<string>"
}
],
"sorts": [
{
"id": "<string>",
"fieldId": "<string>",
"direction": "asc",
"position": 123
}
],
"groupByFieldId": "<string>",
"rowGroupByFieldId": "<string>",
"groupOrder": [
"<string>"
],
"hiddenGroups": [
"<string>"
],
"display": {},
"description": "<string>"
},
"icon": {
"type": "emoji",
"emoji": "page_icon",
"external": {
"url": "https://example.com/image.jpg"
},
"file_upload": {
"id": "fu_abc123"
},
"domain": "acme.com",
"file": {
"url": "https://s3.amazonaws.com/...",
"expiryTime": "2024-01-15T10:30:00.000Z"
},
"lucide": "file-text",
"brand": "github",
"dicebear": {
"style": "notionists-neutral",
"seed": "0256de50-f90c-49a8-81f0-3988b2b89d8d",
"backgroundColor": "b6e3f4,b6e3f4",
"options": {
"brows": "<string>",
"eyes": "<string>",
"glasses": "<string>",
"lips": "<string>",
"nose": "<string>",
"flip": true,
"rotate": 123,
"scale": 123,
"radius": 123,
"size": 123,
"backgroundType": "solid",
"backgroundRotation": [
123
],
"translateX": 123,
"translateY": 123,
"clip": true,
"randomizeIds": true
}
},
"background": "blue",
"empty": true,
"updatedBy": "dataset:empresas"
}
}OAuth2 Authorization Code flow
Object kind this view targets.
report, deal Renderer type.
board, list View name.
View icon.
Show child attributes
View order.
Show child attributes
Object view created.
object_view Unique view id.
report, deal board, list Show child attributes
Show child attributes