Pular para o conteúdo principal
GET
/
search
Buscar Recursos do Tenant
curl --request GET \
  --url https://api.altostrat.io/search \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "doc_1",
      "name": "Documentação do Projeto Alpha",
      "type": "documento",
      "description": "Documentação abrangente para o projeto Alpha, incluindo especificações da API e guias do usuário.",
      "org_id": "org_MyoAolMD2GACSFi8",
      "workspace_id": "ws_sz47boIRd2XfDRk3G0",
      "metadata": {
        "category": "técnico",
        "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

As APIs da Altostrat usam tokens JWT Bearer para autenticação.

Query Parameters

q
string
required

A string de consulta de busca principal. A API realiza uma busca aproximada (fuzzy) nos nomes, descrições e metadados dos recursos.

Required string length: 1 - 255
workspace_id
string

Um filtro opcional para limitar os resultados da busca a um ID de workspace específico. Se fornecido, o org_id é ignorado. Se omitido, a busca assume como padrão o escopo da organização.

org_id
string

Um filtro opcional para limitar os resultados da busca a um ID de organização específico. Geralmente é usado por usuários administrativos para buscar fora de sua organização padrão. Se omitido, a busca é limitada à organização do usuário autenticado.

types
string[]

Um array de tipos de entidade para filtrar os resultados. Por exemplo, types[]=device&types[]=policy retornará apenas entidades desses dois tipos.

created_from
string<date>

A data de início para um filtro de intervalo de data de criação, formatada como AAAA-MM-DD.

created_to
string<date>

A data de término para um filtro de intervalo de data de criação, formatada como AAAA-MM-DD.

page
integer
default:1

O número da página para paginação.

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

O número de resultados a serem retornados por página.

Required range: 1 <= x <= 100

Response

Uma lista paginada de resultados da busca.

data
object[]
meta
object