Search API

Search endpoints exposed by the Devotel CPaaS API Base path: /api/v1/search/global Endpoint count: 1

Global search

POST /api/v1/search/global

string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

string (enum: true|false)

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

string

required

The search string. 1–200 characters; matched against every pillar you list (or all seven when pillars is omitted).

string[]

Optional pillar allowlist — any of contacts, conversations, tickets, agents, calls, numbers, segments (max 8 entries). Omit (or send []) to query every pillar; send a subset to scope the search.

integer

Optional. 1–10, default 5. Caps how many matches each pillar returns.

integer

Optional. 0–100, default 0. The count of non-pillar matches your client already rendered for this query (page, setting, or help-article shortcuts); folded into the recorded result count so successful searches are not mis-counted as zero-result. Palette callers should always send it.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/search/global" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "ady",
  "pillars": [
    "contacts",
    "conversations",
    "tickets",
    "agents",
    "calls",
    "numbers",
    "segments"
  ],
  "per_pillar_limit": 5,
  "static_match_count": 2
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/search/global', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "query": "ady",
  "pillars": [
    "contacts",
    "conversations",
    "tickets",
    "agents",
    "calls",
    "numbers",
    "segments"
  ],
  "per_pillar_limit": 5,
  "static_match_count": 2
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/search/global", headers=headers, json={
  "query": "ady",
  "pillars": [
    "contacts",
    "conversations",
    "tickets",
    "agents",
    "calls",
    "numbers",
    "segments"
  ],
  "per_pillar_limit": 5,
  "static_match_count": 2
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/search/global", bytes.NewBuffer([]byte(`{
  "query": "ady",
  "pillars": [
    "contacts",
    "conversations",
    "tickets",
    "agents",
    "calls",
    "numbers",
    "segments"
  ],
  "per_pillar_limit": 5,
  "static_match_count": 2
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/search/global')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "query": "ady",
  "pillars": [
    "contacts",
    "conversations",
    "tickets",
    "agents",
    "calls",
    "numbers",
    "segments"
  ],
  "per_pillar_limit": 5,
  "static_match_count": 2
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/search/global');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "query": "ady",
  "pillars": [
    "contacts",
    "conversations",
    "tickets",
    "agents",
    "calls",
    "numbers",
    "segments"
  ],
  "per_pillar_limit": 5,
  "static_match_count": 2
}
JSON);
echo curl_exec($ch);

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

API Reference

All Endpoints

Search API

Search API

Global search

​Search API

​Global search

Search API

Global search