Schema
Get object schema
Returns all object types available to the organization along with their field definitions. Use this to discover what objects exist, what fields they have, and what select options are available.
Includes both system object types (People, Companies) and any custom object types created by the organization.
GET
/
api
/
meta
/
schema
Get object schema
curl --request GET \
--url https://app.useitem.io/api/meta/schema \
--header 'x-api-key: <api-key>'import requests
url = "https://app.useitem.io/api/meta/schema"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://app.useitem.io/api/meta/schema', 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://app.useitem.io/api/meta/schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://app.useitem.io/api/meta/schema"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.useitem.io/api/meta/schema")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.useitem.io/api/meta/schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 1,
"slug": "contacts",
"display_name": "People",
"plural_display_name": "People",
"description": "<string>",
"icon": "<string>",
"fields": [
{
"field_name": "industry",
"display_name": "Industry",
"field_type": "select",
"field_order": 5,
"is_required": false,
"description": "<string>",
"select_options": [
{
"label": "Technology",
"value": "technology",
"color": "#3b82f6"
}
],
"allow_multiple": true,
"related_object_type_id": 123,
"number_min": 123,
"number_max": 123,
"number_decimal_places": 123,
"currency_decimal_places": 123,
"default_value": "<string>",
"visibility_type": "visible"
}
]
}
]
}{
"error": "Object not found"
}⌘I
Get object schema
curl --request GET \
--url https://app.useitem.io/api/meta/schema \
--header 'x-api-key: <api-key>'import requests
url = "https://app.useitem.io/api/meta/schema"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://app.useitem.io/api/meta/schema', 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://app.useitem.io/api/meta/schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://app.useitem.io/api/meta/schema"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.useitem.io/api/meta/schema")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.useitem.io/api/meta/schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 1,
"slug": "contacts",
"display_name": "People",
"plural_display_name": "People",
"description": "<string>",
"icon": "<string>",
"fields": [
{
"field_name": "industry",
"display_name": "Industry",
"field_type": "select",
"field_order": 5,
"is_required": false,
"description": "<string>",
"select_options": [
{
"label": "Technology",
"value": "technology",
"color": "#3b82f6"
}
],
"allow_multiple": true,
"related_object_type_id": 123,
"number_min": 123,
"number_max": 123,
"number_decimal_places": 123,
"currency_decimal_places": 123,
"default_value": "<string>",
"visibility_type": "visible"
}
]
}
]
}{
"error": "Object not found"
}