---
title: "Search for mentions"
method: GET
path: "/ocs/v2.php/apps/spreed/api/{apiVersion}/chat/{token}/mentions"
tags: ["chat"]
---

# Search for mentions

`GET /ocs/v2.php/apps/spreed/api/{apiVersion}/chat/{token}/mentions`

## Path parameters

- `apiVersion` 'v1', required
- `token` string, required

## Query parameters

- `search` string, required
- `limit` integer
- `includeStatus` boolean

## Headers

- `x-nextcloud-federation` string
- `OCS-APIRequest` boolean, required

## Response `200`

List of mention suggestions returned

- object
  - `ocs` object, required
    - `meta` OCSMeta, required
      - `status` string, required
      - `statuscode` integer, required
      - `message` string
      - `totalitems` string
      - `itemsperpage` string
    - `data` ChatMentionSuggestion[], required
      - `id` string, required — The actor id of the suggestion
      - `label` string, required — The display name of the suggestion
      - `source` string, required — The source of the suggestion (e.g. `users`, `groups`, `calls`)
      - `mentionId` string, required — The mention id to use for the mention
      - `details` string — Additional details of the suggestion (e.g. group description)
      - `status` string — User status of the suggestion
      - `statusClearAt` integer, nullable — UNIX timestamp when the user status will be cleared
      - `statusIcon` string, nullable — User status icon
      - `statusMessage` string, nullable — User status message

---

[API](https://skmtc.dev/nextcloud/apis/spreed.md) · [All operations](https://skmtc.dev/nextcloud/apis/spreed/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nextcloud/spreed/revisions/7d1eb4fc4413/schema)