Objects
Get an object's schema
Lists the fields of one object type in your workspace, ordered by name, with what each field supports. These are the fields Clearskies maintains; fields as your CRM names them, custom fields included, are not served.
GET
/
v1
/
objects
/
{object}
Get an object's schema
curl --request GET \
--url https://api.clearskies.cc/v1/objects/{object} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.clearskies.cc/v1/objects/{object}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.clearskies.cc/v1/objects/{object}', 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.clearskies.cc/v1/objects/{object}",
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.clearskies.cc/v1/objects/{object}"
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.clearskies.cc/v1/objects/{object}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clearskies.cc/v1/objects/{object}")
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{
"ok": true,
"data": {
"name": "deal",
"label": "Deal",
"custom": false,
"fields": [
{
"name": "account",
"label": "Account",
"type": "reference",
"referenceTo": "account",
"filterable": true,
"sortable": false,
"groupable": false,
"measurable": false,
"operators": [
"equal",
"notEqual",
"isIn",
"isNotIn",
"isEmpty",
"isNotEmpty"
]
},
{
"name": "amount",
"label": "Amount",
"type": "integer",
"filterable": true,
"sortable": true,
"groupable": true,
"measurable": true,
"operators": [
"equal",
"notEqual",
"greaterThan",
"greaterThanOrEqual",
"lessThan",
"lessThanOrEqual",
"isIn",
"isNotIn",
"isEmpty",
"isNotEmpty"
]
},
{
"name": "closeDate",
"label": "Close Date",
"type": "date",
"filterable": true,
"sortable": true,
"groupable": true,
"measurable": false,
"operators": [
"equal",
"notEqual",
"before",
"after",
"isEmpty",
"isNotEmpty"
]
}
]
},
"requestId": "0199f2b0-7c41-7a3e-9d6c-2f5a1b8e4c07"
}{
"ok": false,
"error": {
"code": "BAD_REQUEST",
"message": "filters[0].op \"contains\" is not an operator \"createdAt\" accepts. Valid operators: equal, notEqual, before, after, isEmpty, isNotEmpty."
},
"requestId": "0199f2b0-7c41-7a3e-9d6c-2f5a1b8e4c07"
}{
"ok": false,
"error": {
"code": "BAD_REQUEST",
"message": "<string>"
},
"requestId": "<string>",
"traceId": "<string>"
}{
"ok": false,
"error": {
"code": "BAD_REQUEST",
"message": "<string>"
},
"requestId": "<string>",
"traceId": "<string>"
}{
"ok": false,
"error": {
"code": "BAD_REQUEST",
"message": "<string>"
},
"requestId": "<string>",
"traceId": "<string>"
}{
"ok": false,
"error": {
"code": "BAD_REQUEST",
"message": "<string>"
},
"requestId": "<string>",
"traceId": "<string>"
}{
"ok": false,
"error": {
"code": "BAD_REQUEST",
"message": "<string>"
},
"requestId": "<string>",
"traceId": "<string>"
}{
"ok": false,
"error": {
"code": "BAD_REQUEST",
"message": "<string>"
},
"requestId": "<string>",
"traceId": "<string>"
}The Clearskies API is in beta and available on request. To turn it on for your workspace, email
support@clearskies.cc.
Authorizations
Path Parameters
Was this page helpful?
⌘I
Get an object's schema
curl --request GET \
--url https://api.clearskies.cc/v1/objects/{object} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.clearskies.cc/v1/objects/{object}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.clearskies.cc/v1/objects/{object}', 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.clearskies.cc/v1/objects/{object}",
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.clearskies.cc/v1/objects/{object}"
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.clearskies.cc/v1/objects/{object}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clearskies.cc/v1/objects/{object}")
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{
"ok": true,
"data": {
"name": "deal",
"label": "Deal",
"custom": false,
"fields": [
{
"name": "account",
"label": "Account",
"type": "reference",
"referenceTo": "account",
"filterable": true,
"sortable": false,
"groupable": false,
"measurable": false,
"operators": [
"equal",
"notEqual",
"isIn",
"isNotIn",
"isEmpty",
"isNotEmpty"
]
},
{
"name": "amount",
"label": "Amount",
"type": "integer",
"filterable": true,
"sortable": true,
"groupable": true,
"measurable": true,
"operators": [
"equal",
"notEqual",
"greaterThan",
"greaterThanOrEqual",
"lessThan",
"lessThanOrEqual",
"isIn",
"isNotIn",
"isEmpty",
"isNotEmpty"
]
},
{
"name": "closeDate",
"label": "Close Date",
"type": "date",
"filterable": true,
"sortable": true,
"groupable": true,
"measurable": false,
"operators": [
"equal",
"notEqual",
"before",
"after",
"isEmpty",
"isNotEmpty"
]
}
]
},
"requestId": "0199f2b0-7c41-7a3e-9d6c-2f5a1b8e4c07"
}{
"ok": false,
"error": {
"code": "BAD_REQUEST",
"message": "filters[0].op \"contains\" is not an operator \"createdAt\" accepts. Valid operators: equal, notEqual, before, after, isEmpty, isNotEmpty."
},
"requestId": "0199f2b0-7c41-7a3e-9d6c-2f5a1b8e4c07"
}{
"ok": false,
"error": {
"code": "BAD_REQUEST",
"message": "<string>"
},
"requestId": "<string>",
"traceId": "<string>"
}{
"ok": false,
"error": {
"code": "BAD_REQUEST",
"message": "<string>"
},
"requestId": "<string>",
"traceId": "<string>"
}{
"ok": false,
"error": {
"code": "BAD_REQUEST",
"message": "<string>"
},
"requestId": "<string>",
"traceId": "<string>"
}{
"ok": false,
"error": {
"code": "BAD_REQUEST",
"message": "<string>"
},
"requestId": "<string>",
"traceId": "<string>"
}{
"ok": false,
"error": {
"code": "BAD_REQUEST",
"message": "<string>"
},
"requestId": "<string>",
"traceId": "<string>"
}{
"ok": false,
"error": {
"code": "BAD_REQUEST",
"message": "<string>"
},
"requestId": "<string>",
"traceId": "<string>"
}