Skip to main content
GET
/
search
Search Tenant Resources
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-10-24T12:00:00.000000Z",
      "updated_at": "2025-10-27T15:30:00.000000Z",
      "relevance_percentage": 100,
      "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

Altostrat APIs use JWT Bearer tokens for authentication.

Query Parameters

q
string
required

The primary search query string. The API performs a fuzzy search against resource names, descriptions, and metadata.

Required string length: 1 - 255
workspace_id
string

An optional filter to scope search results to a specific workspace ID. If provided, org_id is ignored. If omitted, the search defaults to the organization scope.

org_id
string

An optional filter to scope search results to a specific organization ID. This is typically used by administrative users to search outside their default organization. If omitted, the search is scoped to the organization of the authenticated user.

types
string[]

An array of entity types to filter the results. For example, types[]=device&types[]=policy will only return entities of those two types.

created_from
string<date>

The start date for a creation date range filter, formatted as YYYY-MM-DD.

created_to
string<date>

The end date for a creation date range filter, formatted as YYYY-MM-DD.

page
integer
default:1

The page number for pagination.

Required range: x >= 1
per_page
integer
default:20

The number of results to return per page.

Required range: 1 <= x <= 100

Response

A paginated list of search results.

data
object[]
meta
object