list_mentions
/mentionsA record is offered only if the caller may list and read it, and through an
installed app only from an entity its ceiling covers. People are offered only
if they can read the record (on a create form, its parent), and through an
installed app only while its package requires the user entity and lists
its name. Built-in directories are never record groups.
A service principal's credential, or a person's access token, AgentFlow's own or an installed app's. A service principal's effective permissions are its role permissions intersected with the credential's scopes.
In: header
Query Parameters
The entity of the record being written about, or of the record a create form will create.
uuidThe record being written about. People are offered only if they can read it, and are then told when mentioned.
uuidOn a create form, the record the new one will be created under: without
record_id, and when the entity references this record's entity,
people are offered only if they can read it. Otherwise it is ignored.
uuidWhat the person has typed after the @ (only the first 64 characters
and 8 words count). Each word must begin a word of a name, an email
told to the caller, or a searched field, accents and case ignored.
Blank lists what the caller mentioned recently.
One group alone: people, or entity:<entity id> for that entity's
records. Absent is the whole menu.
The most rows of each group, 1 to 8. The whole menu shows at most 4 recent records, 3 people and 3 records of each entity; one group alone shows 8 when absent.
int321 <= value <= 8Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/mentions?entity_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "groups": [ { "items": [ { "email": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "is_self": true, "kind": "user", "name": "string", "will_be_notified": true } ], "key": "string", "label": "string", "more": 0, "total": 0 } ], "unsearched": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "string", "label": "string" } ]}