Skip to main content
GET
/
search
Search for Platform Entities
curl --request GET \
  --url https://v1.api.altostrat.io/search \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://v1.api.altostrat.io/search"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://v1.api.altostrat.io/search', 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://v1.api.altostrat.io/search",
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://v1.api.altostrat.io/search"

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://v1.api.altostrat.io/search")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://v1.api.altostrat.io/search")

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
{
  "data": [
    {
      "id": "doc_1",
      "name": "Project Alpha Documentation",
      "type": "document",
      "description": "Comprehensive documentation for the Alpha project including API specifications and user guides.",
      "org_id": "org_MyoAolMD2GACSFi8",
      "workspace_id": "ws_sz47boIRd2XfDRk3G0",
      "metadata": {
        "category": "technical",
        "resource_id\"": "res_doc_001"
      },
      "created_at": "2025-11-04T08:36:48.000000Z",
      "updated_at": "2025-11-07T08:36:48.000000Z",
      "relevance_percentage": 95,
      "scout_score": 123456789
    }
  ],
  "links": {
    "first": "https://v1.api.altostrat.io/search?page=1",
    "last": "https://v1.api.altostrat.io/search?page=5",
    "prev": null,
    "next": "https://v1.api.altostrat.io/search?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "path": "https://v1.api.altostrat.io/search",
    "per_page": 20,
    "to": 20,
    "total": 95
  }
}
{
"type": "invalid_request_error",
"code": "parameter_missing",
"message": "The 'q' parameter is required for this request.",
"doc_url": "https://docs.altostrat.io/errors/parameter_missing"
}
{
"type": "invalid_request_error",
"code": "parameter_missing",
"message": "The 'q' parameter is required for this request.",
"doc_url": "https://docs.altostrat.io/errors/parameter_missing"
}
{
"type": "invalid_request_error",
"code": "parameter_missing",
"message": "The 'q' parameter is required for this request.",
"doc_url": "https://docs.altostrat.io/errors/parameter_missing"
}
{
"type": "invalid_request_error",
"code": "parameter_missing",
"message": "The 'q' parameter is required for this request.",
"doc_url": "https://docs.altostrat.io/errors/parameter_missing"
}

Authorizations

Authorization
string
header
required

Enter your bearer token in the format: Bearer {token}

Query Parameters

q
string
required

The primary search query string. The search engine performs a fuzzy search across entity names, descriptions, and key metadata fields.

Required string length: 1 - 255
workspace_id
string

The unique identifier for a Workspace (ws_...). Specifying this ID scopes the search exclusively to entities within that workspace, overriding the broader organization-level scope. Cannot be used with org_id.

org_id
string

The unique identifier for an Organization (org_...). Allows an administrator to override the default search scope from their own organization to another. Cannot be used with workspace_id.

types
string[]

An array of entity types to filter the search results. Only entities matching one of the provided types will be returned.

created_from
string<date>

The start date for a date-range filter on the entity's creation timestamp. Formatted as YYYY-MM-DD.

created_to
string<date>

The end date for a date-range filter on the entity's creation timestamp. Formatted as YYYY-MM-DD.

page
integer
default:1

The page number of the result set to retrieve.

Required range: x >= 1

Response

A paginated list of matching entities.

data
object[]
meta
object