Records

Query records

Returns one page of records matching every filter. Each record carries id and the fields you asked for; with no fields, it carries the object’s default fields.

To read the next page, send the same request again with cursor set to the previous page’s pagination.nextCursor. A cursor only works with the filters, sort and fields it was issued under. nextCursor is null on the last page.

A call query returns only the calls the key’s owner can open: see GET /v1/objects/call/{id}/transcript.

POST

objects

{object}

query

Query records

curl --request POST \
  --url https://api.clearskies.cc/v1/objects/{object}/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": [
    {
      "field": "amount",
      "op": "greaterThanOrEqual",
      "value": 50000
    },
    {
      "field": "closeDate",
      "op": "before",
      "value": "2026-12-31"
    }
  ],
  "sort": [
    {
      "field": "closeDate",
      "direction": "asc"
    }
  ],
  "fields": [
    "name",
    "stage",
    "amount",
    "closeDate",
    "account"
  ],
  "pageSize": 50,
  "includeTotalCount": true
}
'

import requests

url = "https://api.clearskies.cc/v1/objects/{object}/query"

payload = {
    "filters": [
        {
            "field": "amount",
            "op": "greaterThanOrEqual",
            "value": 50000
        },
        {
            "field": "closeDate",
            "op": "before",
            "value": "2026-12-31"
        }
    ],
    "sort": [
        {
            "field": "closeDate",
            "direction": "asc"
        }
    ],
    "fields": ["name", "stage", "amount", "closeDate", "account"],
    "pageSize": 50,
    "includeTotalCount": True
}
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({
    filters: [
      {field: 'amount', op: 'greaterThanOrEqual', value: 50000},
      {field: 'closeDate', op: 'before', value: '2026-12-31'}
    ],
    sort: [{field: 'closeDate', direction: 'asc'}],
    fields: ['name', 'stage', 'amount', 'closeDate', 'account'],
    pageSize: 50,
    includeTotalCount: true
  })
};

fetch('https://api.clearskies.cc/v1/objects/{object}/query', 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}/query",
  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([
    'filters' => [
        [
                'field' => 'amount',
                'op' => 'greaterThanOrEqual',
                'value' => 50000
        ],
        [
                'field' => 'closeDate',
                'op' => 'before',
                'value' => '2026-12-31'
        ]
    ],
    'sort' => [
        [
                'field' => 'closeDate',
                'direction' => 'asc'
        ]
    ],
    'fields' => [
        'name',
        'stage',
        'amount',
        'closeDate',
        'account'
    ],
    'pageSize' => 50,
    'includeTotalCount' => true
  ]),
  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 := "https://api.clearskies.cc/v1/objects/{object}/query"

	payload := strings.NewReader("{\n  \"filters\": [\n    {\n      \"field\": \"amount\",\n      \"op\": \"greaterThanOrEqual\",\n      \"value\": 50000\n    },\n    {\n      \"field\": \"closeDate\",\n      \"op\": \"before\",\n      \"value\": \"2026-12-31\"\n    }\n  ],\n  \"sort\": [\n    {\n      \"field\": \"closeDate\",\n      \"direction\": \"asc\"\n    }\n  ],\n  \"fields\": [\n    \"name\",\n    \"stage\",\n    \"amount\",\n    \"closeDate\",\n    \"account\"\n  ],\n  \"pageSize\": 50,\n  \"includeTotalCount\": true\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("https://api.clearskies.cc/v1/objects/{object}/query")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filters\": [\n    {\n      \"field\": \"amount\",\n      \"op\": \"greaterThanOrEqual\",\n      \"value\": 50000\n    },\n    {\n      \"field\": \"closeDate\",\n      \"op\": \"before\",\n      \"value\": \"2026-12-31\"\n    }\n  ],\n  \"sort\": [\n    {\n      \"field\": \"closeDate\",\n      \"direction\": \"asc\"\n    }\n  ],\n  \"fields\": [\n    \"name\",\n    \"stage\",\n    \"amount\",\n    \"closeDate\",\n    \"account\"\n  ],\n  \"pageSize\": 50,\n  \"includeTotalCount\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clearskies.cc/v1/objects/{object}/query")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filters\": [\n    {\n      \"field\": \"amount\",\n      \"op\": \"greaterThanOrEqual\",\n      \"value\": 50000\n    },\n    {\n      \"field\": \"closeDate\",\n      \"op\": \"before\",\n      \"value\": \"2026-12-31\"\n    }\n  ],\n  \"sort\": [\n    {\n      \"field\": \"closeDate\",\n      \"direction\": \"asc\"\n    }\n  ],\n  \"fields\": [\n    \"name\",\n    \"stage\",\n    \"amount\",\n    \"closeDate\",\n    \"account\"\n  ],\n  \"pageSize\": 50,\n  \"includeTotalCount\": true\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "data": {
    "records": [
      {
        "id": "0198c7e2-51aa-7d41-b3f0-6e2a9c8d1f45",
        "name": "Acme renewal",
        "stage": "Negotiation",
        "amount": 72000,
        "closeDate": "2026-11-30",
        "account": {
          "id": "0198c7e1-0f3b-7a52-8c6d-1b4e7f9a2c30",
          "name": "Acme"
        }
      }
    ],
    "pagination": {
      "nextCursor": "eyJmaW5nZXJwcmludCI6Ii4uLiJ9",
      "totalCount": 132
    }
  },
  "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

Authorization

string

header

required

An API key created under Context Graph → API keys in the app sidebar, sent as Authorization: Bearer csk_…. The key is checked on every request, so a revoked key fails on its next call.

Path Parameters

object

enum<string>

required

The object type. An unknown name is a 400, and the message lists the valid ones.

Available options:

account,

call,

contact,

deal

Body

application/json

Every member is optional, and a member sent as null counts as omitted. An empty body returns the first page of every record.

filters

object[] | null

Maximum array length: 100

Show child attributes

sort

object[] | null

Applied in order. Without it, records come in a fixed default order.

Maximum array length: 100

Show child attributes

fields

string[] | null

The fields each record carries. Without it, records carry the object's default fields.

Maximum array length: 100

pageSize

integer | null

default:25

Records per page. 0 means the default.

Required range: 0 <= x <= 100

cursor

string | null

The previous page's pagination.nextCursor. Omit it for the first page.

includeTotalCount

boolean | null

default:false

Count every matching record. Only the first page carries the count.

Response

One page of records.

boolean

required

data

object

required

Show child attributes

requestId

string

required

Identifies this call. Quote it when you contact support.

traceId

string

Present on a traced request.

⌘I

Query records

curl --request POST \
  --url https://api.clearskies.cc/v1/objects/{object}/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": [
    {
      "field": "amount",
      "op": "greaterThanOrEqual",
      "value": 50000
    },
    {
      "field": "closeDate",
      "op": "before",
      "value": "2026-12-31"
    }
  ],
  "sort": [
    {
      "field": "closeDate",
      "direction": "asc"
    }
  ],
  "fields": [
    "name",
    "stage",
    "amount",
    "closeDate",
    "account"
  ],
  "pageSize": 50,
  "includeTotalCount": true
}
'

import requests

url = "https://api.clearskies.cc/v1/objects/{object}/query"

payload = {
    "filters": [
        {
            "field": "amount",
            "op": "greaterThanOrEqual",
            "value": 50000
        },
        {
            "field": "closeDate",
            "op": "before",
            "value": "2026-12-31"
        }
    ],
    "sort": [
        {
            "field": "closeDate",
            "direction": "asc"
        }
    ],
    "fields": ["name", "stage", "amount", "closeDate", "account"],
    "pageSize": 50,
    "includeTotalCount": True
}
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({
    filters: [
      {field: 'amount', op: 'greaterThanOrEqual', value: 50000},
      {field: 'closeDate', op: 'before', value: '2026-12-31'}
    ],
    sort: [{field: 'closeDate', direction: 'asc'}],
    fields: ['name', 'stage', 'amount', 'closeDate', 'account'],
    pageSize: 50,
    includeTotalCount: true
  })
};

fetch('https://api.clearskies.cc/v1/objects/{object}/query', 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}/query",
  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([
    'filters' => [
        [
                'field' => 'amount',
                'op' => 'greaterThanOrEqual',
                'value' => 50000
        ],
        [
                'field' => 'closeDate',
                'op' => 'before',
                'value' => '2026-12-31'
        ]
    ],
    'sort' => [
        [
                'field' => 'closeDate',
                'direction' => 'asc'
        ]
    ],
    'fields' => [
        'name',
        'stage',
        'amount',
        'closeDate',
        'account'
    ],
    'pageSize' => 50,
    'includeTotalCount' => true
  ]),
  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 := "https://api.clearskies.cc/v1/objects/{object}/query"

	payload := strings.NewReader("{\n  \"filters\": [\n    {\n      \"field\": \"amount\",\n      \"op\": \"greaterThanOrEqual\",\n      \"value\": 50000\n    },\n    {\n      \"field\": \"closeDate\",\n      \"op\": \"before\",\n      \"value\": \"2026-12-31\"\n    }\n  ],\n  \"sort\": [\n    {\n      \"field\": \"closeDate\",\n      \"direction\": \"asc\"\n    }\n  ],\n  \"fields\": [\n    \"name\",\n    \"stage\",\n    \"amount\",\n    \"closeDate\",\n    \"account\"\n  ],\n  \"pageSize\": 50,\n  \"includeTotalCount\": true\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("https://api.clearskies.cc/v1/objects/{object}/query")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filters\": [\n    {\n      \"field\": \"amount\",\n      \"op\": \"greaterThanOrEqual\",\n      \"value\": 50000\n    },\n    {\n      \"field\": \"closeDate\",\n      \"op\": \"before\",\n      \"value\": \"2026-12-31\"\n    }\n  ],\n  \"sort\": [\n    {\n      \"field\": \"closeDate\",\n      \"direction\": \"asc\"\n    }\n  ],\n  \"fields\": [\n    \"name\",\n    \"stage\",\n    \"amount\",\n    \"closeDate\",\n    \"account\"\n  ],\n  \"pageSize\": 50,\n  \"includeTotalCount\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clearskies.cc/v1/objects/{object}/query")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filters\": [\n    {\n      \"field\": \"amount\",\n      \"op\": \"greaterThanOrEqual\",\n      \"value\": 50000\n    },\n    {\n      \"field\": \"closeDate\",\n      \"op\": \"before\",\n      \"value\": \"2026-12-31\"\n    }\n  ],\n  \"sort\": [\n    {\n      \"field\": \"closeDate\",\n      \"direction\": \"asc\"\n    }\n  ],\n  \"fields\": [\n    \"name\",\n    \"stage\",\n    \"amount\",\n    \"closeDate\",\n    \"account\"\n  ],\n  \"pageSize\": 50,\n  \"includeTotalCount\": true\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "data": {
    "records": [
      {
        "id": "0198c7e2-51aa-7d41-b3f0-6e2a9c8d1f45",
        "name": "Acme renewal",
        "stage": "Negotiation",
        "amount": 72000,
        "closeDate": "2026-11-30",
        "account": {
          "id": "0198c7e1-0f3b-7a52-8c6d-1b4e7f9a2c30",
          "name": "Acme"
        }
      }
    ],
    "pagination": {
      "nextCursor": "eyJmaW5nZXJwcmludCI6Ii4uLiJ9",
      "totalCount": 132
    }
  },
  "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>"
}

Welcome to Clearskies

Getting Started

Unifying GTM Data

Building with Clearskies

Ask AI

Use Cases

Support

Query records

Authorizations

Path Parameters

Body

Response