Skip to main content
POST
/
draftt
/
query
Query upgrade plans with filtering, sorting and pagination
curl --request POST \
  --url https://api.draftt.io/v1/draftt/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": {
    "$and": "<array>",
    "$or": "<array>",
    "id": {
      "$eq": "<string>",
      "$ne": "<string>",
      "$gt": "<string>",
      "$gte": "<string>",
      "$lt": "<string>",
      "$lte": "<string>",
      "$like": "<string>",
      "$in": [
        "<string>"
      ],
      "$nin": [
        "<string>"
      ],
      "$exists": true
    },
    "componentId": {
      "$eq": 123,
      "$ne": 123,
      "$gt": 123,
      "$gte": 123,
      "$lt": 123,
      "$lte": 123,
      "$in": [
        123
      ],
      "$nin": [
        123
      ],
      "$exists": true
    },
    "technology": {
      "$eq": "<string>",
      "$ne": "<string>",
      "$gt": "<string>",
      "$gte": "<string>",
      "$lt": "<string>",
      "$lte": "<string>",
      "$like": "<string>",
      "$in": [
        "<string>"
      ],
      "$nin": [
        "<string>"
      ],
      "$exists": true
    },
    "status": {
      "$eq": "<string>",
      "$ne": "<string>",
      "$gt": "<string>",
      "$gte": "<string>",
      "$lt": "<string>",
      "$lte": "<string>",
      "$like": "<string>",
      "$in": [
        "<string>"
      ],
      "$nin": [
        "<string>"
      ],
      "$exists": true
    },
    "currentVersion": {
      "$eq": "<string>",
      "$ne": "<string>",
      "$gt": "<string>",
      "$gte": "<string>",
      "$lt": "<string>",
      "$lte": "<string>",
      "$like": "<string>",
      "$in": [
        "<string>"
      ],
      "$nin": [
        "<string>"
      ],
      "$exists": true
    },
    "desiredVersion": {
      "$eq": "<string>",
      "$ne": "<string>",
      "$gt": "<string>",
      "$gte": "<string>",
      "$lt": "<string>",
      "$lte": "<string>",
      "$like": "<string>",
      "$in": [
        "<string>"
      ],
      "$nin": [
        "<string>"
      ],
      "$exists": true
    },
    "createdAt": {
      "$eq": "<string>",
      "$ne": "<string>",
      "$gt": "<string>",
      "$gte": "<string>",
      "$lt": "<string>",
      "$lte": "<string>",
      "$like": "<string>",
      "$in": [
        "<string>"
      ],
      "$nin": [
        "<string>"
      ],
      "$exists": true
    },
    "updatedAt": {
      "$eq": "<string>",
      "$ne": "<string>",
      "$gt": "<string>",
      "$gte": "<string>",
      "$lt": "<string>",
      "$lte": "<string>",
      "$like": "<string>",
      "$in": [
        "<string>"
      ],
      "$nin": [
        "<string>"
      ],
      "$exists": true
    },
    "completedAt": {
      "$eq": "<string>",
      "$ne": "<string>",
      "$gt": "<string>",
      "$gte": "<string>",
      "$lt": "<string>",
      "$lte": "<string>",
      "$like": "<string>",
      "$in": [
        "<string>"
      ],
      "$nin": [
        "<string>"
      ],
      "$exists": true
    }
  },
  "select": [],
  "sort": {},
  "pageToken": "<string>",
  "pageSize": 100
}
'
import requests

url = "https://api.draftt.io/v1/draftt/query"

payload = {
    "filter": {
        "$and": "<array>",
        "$or": "<array>",
        "id": {
            "$eq": "<string>",
            "$ne": "<string>",
            "$gt": "<string>",
            "$gte": "<string>",
            "$lt": "<string>",
            "$lte": "<string>",
            "$like": "<string>",
            "$in": ["<string>"],
            "$nin": ["<string>"],
            "$exists": True
        },
        "componentId": {
            "$eq": 123,
            "$ne": 123,
            "$gt": 123,
            "$gte": 123,
            "$lt": 123,
            "$lte": 123,
            "$in": [123],
            "$nin": [123],
            "$exists": True
        },
        "technology": {
            "$eq": "<string>",
            "$ne": "<string>",
            "$gt": "<string>",
            "$gte": "<string>",
            "$lt": "<string>",
            "$lte": "<string>",
            "$like": "<string>",
            "$in": ["<string>"],
            "$nin": ["<string>"],
            "$exists": True
        },
        "status": {
            "$eq": "<string>",
            "$ne": "<string>",
            "$gt": "<string>",
            "$gte": "<string>",
            "$lt": "<string>",
            "$lte": "<string>",
            "$like": "<string>",
            "$in": ["<string>"],
            "$nin": ["<string>"],
            "$exists": True
        },
        "currentVersion": {
            "$eq": "<string>",
            "$ne": "<string>",
            "$gt": "<string>",
            "$gte": "<string>",
            "$lt": "<string>",
            "$lte": "<string>",
            "$like": "<string>",
            "$in": ["<string>"],
            "$nin": ["<string>"],
            "$exists": True
        },
        "desiredVersion": {
            "$eq": "<string>",
            "$ne": "<string>",
            "$gt": "<string>",
            "$gte": "<string>",
            "$lt": "<string>",
            "$lte": "<string>",
            "$like": "<string>",
            "$in": ["<string>"],
            "$nin": ["<string>"],
            "$exists": True
        },
        "createdAt": {
            "$eq": "<string>",
            "$ne": "<string>",
            "$gt": "<string>",
            "$gte": "<string>",
            "$lt": "<string>",
            "$lte": "<string>",
            "$like": "<string>",
            "$in": ["<string>"],
            "$nin": ["<string>"],
            "$exists": True
        },
        "updatedAt": {
            "$eq": "<string>",
            "$ne": "<string>",
            "$gt": "<string>",
            "$gte": "<string>",
            "$lt": "<string>",
            "$lte": "<string>",
            "$like": "<string>",
            "$in": ["<string>"],
            "$nin": ["<string>"],
            "$exists": True
        },
        "completedAt": {
            "$eq": "<string>",
            "$ne": "<string>",
            "$gt": "<string>",
            "$gte": "<string>",
            "$lt": "<string>",
            "$lte": "<string>",
            "$like": "<string>",
            "$in": ["<string>"],
            "$nin": ["<string>"],
            "$exists": True
        }
    },
    "select": [],
    "sort": {},
    "pageToken": "<string>",
    "pageSize": 100
}
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({
    filter: {
      $and: '<array>',
      $or: '<array>',
      id: {
        $eq: '<string>',
        $ne: '<string>',
        $gt: '<string>',
        $gte: '<string>',
        $lt: '<string>',
        $lte: '<string>',
        $like: '<string>',
        $in: ['<string>'],
        $nin: ['<string>'],
        $exists: true
      },
      componentId: {
        $eq: 123,
        $ne: 123,
        $gt: 123,
        $gte: 123,
        $lt: 123,
        $lte: 123,
        $in: [123],
        $nin: [123],
        $exists: true
      },
      technology: {
        $eq: '<string>',
        $ne: '<string>',
        $gt: '<string>',
        $gte: '<string>',
        $lt: '<string>',
        $lte: '<string>',
        $like: '<string>',
        $in: ['<string>'],
        $nin: ['<string>'],
        $exists: true
      },
      status: {
        $eq: '<string>',
        $ne: '<string>',
        $gt: '<string>',
        $gte: '<string>',
        $lt: '<string>',
        $lte: '<string>',
        $like: '<string>',
        $in: ['<string>'],
        $nin: ['<string>'],
        $exists: true
      },
      currentVersion: {
        $eq: '<string>',
        $ne: '<string>',
        $gt: '<string>',
        $gte: '<string>',
        $lt: '<string>',
        $lte: '<string>',
        $like: '<string>',
        $in: ['<string>'],
        $nin: ['<string>'],
        $exists: true
      },
      desiredVersion: {
        $eq: '<string>',
        $ne: '<string>',
        $gt: '<string>',
        $gte: '<string>',
        $lt: '<string>',
        $lte: '<string>',
        $like: '<string>',
        $in: ['<string>'],
        $nin: ['<string>'],
        $exists: true
      },
      createdAt: {
        $eq: '<string>',
        $ne: '<string>',
        $gt: '<string>',
        $gte: '<string>',
        $lt: '<string>',
        $lte: '<string>',
        $like: '<string>',
        $in: ['<string>'],
        $nin: ['<string>'],
        $exists: true
      },
      updatedAt: {
        $eq: '<string>',
        $ne: '<string>',
        $gt: '<string>',
        $gte: '<string>',
        $lt: '<string>',
        $lte: '<string>',
        $like: '<string>',
        $in: ['<string>'],
        $nin: ['<string>'],
        $exists: true
      },
      completedAt: {
        $eq: '<string>',
        $ne: '<string>',
        $gt: '<string>',
        $gte: '<string>',
        $lt: '<string>',
        $lte: '<string>',
        $like: '<string>',
        $in: ['<string>'],
        $nin: ['<string>'],
        $exists: true
      }
    },
    select: [],
    sort: {},
    pageToken: '<string>',
    pageSize: 100
  })
};

fetch('https://api.draftt.io/v1/draftt/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.draftt.io/v1/draftt/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([
    'filter' => [
        '$and' => '<array>',
        '$or' => '<array>',
        'id' => [
                '$eq' => '<string>',
                '$ne' => '<string>',
                '$gt' => '<string>',
                '$gte' => '<string>',
                '$lt' => '<string>',
                '$lte' => '<string>',
                '$like' => '<string>',
                '$in' => [
                                '<string>'
                ],
                '$nin' => [
                                '<string>'
                ],
                '$exists' => true
        ],
        'componentId' => [
                '$eq' => 123,
                '$ne' => 123,
                '$gt' => 123,
                '$gte' => 123,
                '$lt' => 123,
                '$lte' => 123,
                '$in' => [
                                123
                ],
                '$nin' => [
                                123
                ],
                '$exists' => true
        ],
        'technology' => [
                '$eq' => '<string>',
                '$ne' => '<string>',
                '$gt' => '<string>',
                '$gte' => '<string>',
                '$lt' => '<string>',
                '$lte' => '<string>',
                '$like' => '<string>',
                '$in' => [
                                '<string>'
                ],
                '$nin' => [
                                '<string>'
                ],
                '$exists' => true
        ],
        'status' => [
                '$eq' => '<string>',
                '$ne' => '<string>',
                '$gt' => '<string>',
                '$gte' => '<string>',
                '$lt' => '<string>',
                '$lte' => '<string>',
                '$like' => '<string>',
                '$in' => [
                                '<string>'
                ],
                '$nin' => [
                                '<string>'
                ],
                '$exists' => true
        ],
        'currentVersion' => [
                '$eq' => '<string>',
                '$ne' => '<string>',
                '$gt' => '<string>',
                '$gte' => '<string>',
                '$lt' => '<string>',
                '$lte' => '<string>',
                '$like' => '<string>',
                '$in' => [
                                '<string>'
                ],
                '$nin' => [
                                '<string>'
                ],
                '$exists' => true
        ],
        'desiredVersion' => [
                '$eq' => '<string>',
                '$ne' => '<string>',
                '$gt' => '<string>',
                '$gte' => '<string>',
                '$lt' => '<string>',
                '$lte' => '<string>',
                '$like' => '<string>',
                '$in' => [
                                '<string>'
                ],
                '$nin' => [
                                '<string>'
                ],
                '$exists' => true
        ],
        'createdAt' => [
                '$eq' => '<string>',
                '$ne' => '<string>',
                '$gt' => '<string>',
                '$gte' => '<string>',
                '$lt' => '<string>',
                '$lte' => '<string>',
                '$like' => '<string>',
                '$in' => [
                                '<string>'
                ],
                '$nin' => [
                                '<string>'
                ],
                '$exists' => true
        ],
        'updatedAt' => [
                '$eq' => '<string>',
                '$ne' => '<string>',
                '$gt' => '<string>',
                '$gte' => '<string>',
                '$lt' => '<string>',
                '$lte' => '<string>',
                '$like' => '<string>',
                '$in' => [
                                '<string>'
                ],
                '$nin' => [
                                '<string>'
                ],
                '$exists' => true
        ],
        'completedAt' => [
                '$eq' => '<string>',
                '$ne' => '<string>',
                '$gt' => '<string>',
                '$gte' => '<string>',
                '$lt' => '<string>',
                '$lte' => '<string>',
                '$like' => '<string>',
                '$in' => [
                                '<string>'
                ],
                '$nin' => [
                                '<string>'
                ],
                '$exists' => true
        ]
    ],
    'select' => [
        
    ],
    'sort' => [
        
    ],
    'pageToken' => '<string>',
    'pageSize' => 100
  ]),
  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.draftt.io/v1/draftt/query"

	payload := strings.NewReader("{\n  \"filter\": {\n    \"$and\": \"<array>\",\n    \"$or\": \"<array>\",\n    \"id\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"componentId\": {\n      \"$eq\": 123,\n      \"$ne\": 123,\n      \"$gt\": 123,\n      \"$gte\": 123,\n      \"$lt\": 123,\n      \"$lte\": 123,\n      \"$in\": [\n        123\n      ],\n      \"$nin\": [\n        123\n      ],\n      \"$exists\": true\n    },\n    \"technology\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"status\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"currentVersion\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"desiredVersion\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"createdAt\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"updatedAt\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"completedAt\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    }\n  },\n  \"select\": [],\n  \"sort\": {},\n  \"pageToken\": \"<string>\",\n  \"pageSize\": 100\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.draftt.io/v1/draftt/query")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filter\": {\n    \"$and\": \"<array>\",\n    \"$or\": \"<array>\",\n    \"id\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"componentId\": {\n      \"$eq\": 123,\n      \"$ne\": 123,\n      \"$gt\": 123,\n      \"$gte\": 123,\n      \"$lt\": 123,\n      \"$lte\": 123,\n      \"$in\": [\n        123\n      ],\n      \"$nin\": [\n        123\n      ],\n      \"$exists\": true\n    },\n    \"technology\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"status\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"currentVersion\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"desiredVersion\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"createdAt\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"updatedAt\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"completedAt\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    }\n  },\n  \"select\": [],\n  \"sort\": {},\n  \"pageToken\": \"<string>\",\n  \"pageSize\": 100\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.draftt.io/v1/draftt/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  \"filter\": {\n    \"$and\": \"<array>\",\n    \"$or\": \"<array>\",\n    \"id\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"componentId\": {\n      \"$eq\": 123,\n      \"$ne\": 123,\n      \"$gt\": 123,\n      \"$gte\": 123,\n      \"$lt\": 123,\n      \"$lte\": 123,\n      \"$in\": [\n        123\n      ],\n      \"$nin\": [\n        123\n      ],\n      \"$exists\": true\n    },\n    \"technology\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"status\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"currentVersion\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"desiredVersion\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"createdAt\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"updatedAt\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    },\n    \"completedAt\": {\n      \"$eq\": \"<string>\",\n      \"$ne\": \"<string>\",\n      \"$gt\": \"<string>\",\n      \"$gte\": \"<string>\",\n      \"$lt\": \"<string>\",\n      \"$lte\": \"<string>\",\n      \"$like\": \"<string>\",\n      \"$in\": [\n        \"<string>\"\n      ],\n      \"$nin\": [\n        \"<string>\"\n      ],\n      \"$exists\": true\n    }\n  },\n  \"select\": [],\n  \"sort\": {},\n  \"pageToken\": \"<string>\",\n  \"pageSize\": 100\n}"

response = http.request(request)
puts response.read_body
{
  "nextPageToken": "eyJ1bmlxdWVGaWVsZE5hbWUiOiJpZCIsInNvcnQiOnsic3RhdHVzIjp7ImRpcmVjdGlvbiI6ImFzYyJ9fX0=",
  "items": [
    {
      "id": "abc123",
      "componentId": "27448",
      "technology": "k8s",
      "status": "active",
      "currentVersion": "1.28",
      "desiredVersion": "1.30",
      "createdAt": "2025-01-10T08:00:00.000Z",
      "updatedAt": "2025-04-01T12:00:00.000Z",
      "completedAt": null
    },
    "..."
  ]
}
{
  "error": {
    "message": "<string>"
  }
}
{
  "error": {
    "message": "<string>"
  }
}
{
  "error": {
    "message": "<string>"
  }
}
{
  "error": {
    "message": "<string>"
  }
}
{
  "error": {
    "message": "<string>"
  }
}
{
  "error": {
    "message": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
filter
object
​
select
enum<string>[]

If empty - will return all fields, if passed will only return selected fields

Available options:
id,
componentId,
technology,
status,
currentVersion,
desiredVersion,
createdAt,
updatedAt,
completedAt
​
sort
object

Optional sorting options, if not passed will sort by creation date in ascending order

​
pageToken
string

Base64 token for pagination

​
pageSize
integer
default:100

Number of items to return per page

Required range: 1 <= x <= 1000

Response

Success

​
items
object[]
required
​
nextPageToken
string | null

Token for fetching the next page of results