Référence APIRecherche globale
GET/v1/search

Recherche globale

Recherche transversale dans les ressources du workspace.

1 min de lectureTélécharger en PDF

Réponse exemple

{
"q": "acme",
"kinds": [
"transfers",
"coffres",
"requests",
"folders",
"collections",
"rooms"
],
"total": 2,
"results": {
"rooms": [],
"coffres": [
{
"id": "cof_001",
"slug": "acme-vault",
"title": "Acme Vault",
"status": "active"
}
],
"folders": [],
"requests": [],
"transfers": [
{
"id": "tr_001",
"status": "active",
"short_code": "ABC123",
"transfer_title": "Acme Q4 Financial",
"total_downloads": 42
}
],
"collections": []
}
}

Recherche globale dans le workspace : transferts, coffres, demandes, dossiers, collections et rooms. Résultats groupés par type.

Authentification

Requiert une clé API avec le scope transfers:read.

Paramètres de requête

ParamètreTypeRequisDescription
qstringOuiTerme de recherche (min 2 caractères).
limit_per_kindnumberNonRésultats par type (défaut 10, max 50).
kindsstringNonTypes à inclure, séparés par des virgules (défaut tous).

Codes de statut

  • 200 Résultats renvoyés.
  • 400 Terme trop court.
  • 403 Scope insuffisant.