Skip to main content
GET
/
search
Search for Platform Entities
curl --request GET \
  --url https://api.altostrat.io/search \
  --header 'Authorization: Bearer <token>'
{
  "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://api.altostrat.io/search?page=1",
    "last": "https://api.altostrat.io/search?page=5",
    "prev": null,
    "next": "https://api.altostrat.io/search?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "path": "https://api.altostrat.io/search",
    "per_page": 20,
    "to": 20,
    "total": 95
  }
}

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[]
​
links
object
​
meta
object