Mentions Completions

Information about users and groups to mention in a feed item body or comment body. Use this resource to generate a list of proposed mentions that a user can choose from. A mention is an “@” character followed by a user or group name. When a user or group is mentioned, they receive a notification.

Resource

Available since version

29.0

Requires Chatter

Yes

HTTP methods

GET, HEAD

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Since
`contextId`	String	A feed item ID (for a mention in a comment) or a feed subject ID (for a mention in a feed item) that narrows search results, with more useful results listed first.	Optional	29.0
`page`	Integer	The number of the page you want returned. Numbering starts at 0. If you pass `0` or omit the property, the first page is returned. Attempting to page beyond 500 results returns an empty response.	Optional	29.0
`pageSize`	Integer	The number of items per page. Valid values are between 1 and 100. The default size is 25. Attempting to retrieve more than 500 results returns an empty response.	Optional	29.0
`q`	String	A search term. Searches for matching user and group names. To search for a user, a minimum of 1 character is required. To search for a group, a minimum of 2 characters is required. This parameter does not support wildcards.	Required	29.0
`type`	String	The type of mention completion. One of these values: `All`—All mention completions, regardless of the type of record to which the mention refers. `Group`—Mention completions for groups. `User`—Mention completions for users. The default value is `All`.	Optional	29.0

Response body for GET

Mention Completion Page

Example for GET

This example specifies a feed item ID in the contextId parameter to request mention completions for a comment on the feed item:

This is the response body:

Chatter REST API Developer's Guide

Mentions Completions

See Also: