Account

Unified workspace search

Finds projects, task lists, tasks, folders, files and majlis topics by name (Arabic-normalized, within the key's company). Returns the refs and ids the other endpoints take. Each kind is capped independently (per_type); truncated names every kind that had more matches than were returned. widened names every kind where no record carried every word of the query, so its hits are near-misses: check one before acting on it. A blank q returns empty results. Requires operation account:read.

get/search

Request

  • Base URL: https://app.fareeqy.com/api/v1
  • URL: https://app.fareeqy.com/api/v1/search
  • Auth: HTTP bearer

Query parameters

qstring

The search term. Blank returns empty results.

typesstring[]

Restrict to these kinds. Omit for all kinds. Unknown names are ignored.

per_typeinteger

Max hits per kind (default 5, max 25, clamped).

Response

Search results.

Example response

{
  "data": {
    "results": [
      {
        "type": "project",
        "id": "prj-8f3kd",
        "url": "https://app.fareeqy.com/projects/prj-8f3kd",
        "title": "تطوير الموقع",
        "project_slug": "prj-8f3kd",
        "archived": false
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.