List mentionable users

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Returns the people a comment on the app can mention: the app's owner and everyone who can edit it, sorted by name.

This is limited to 600 requests per minute per app, shared by List comments and List mentionable users. A signed-in session has its own limit, and every personal access token for the workspace shares one. Some workspaces have a different limit. Every request that counts against the limit gets X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix time in seconds) headers, and a 429 also gets Retry-After in seconds. If the limiter itself is unavailable, requests go through without these headers.

<Note>Call this as an editor of the app, with a personal access token sent as a Bearer token or from a signed-in session. A read-only token works here. Workspace API keys aren't accepted.</Note>

get/api/apps/{app_id}/comments/mentionable

Path parameters

app_idstring required

ID of the app.

ID of the app.

Response

The people a comment can mention, sorted by name.

emailstring required

Email to pass in mentioned_emails.

namestring required

Name of the person, or their email when they have no name.

avatar_urlstring nullable

URL of the person's profile image, or null when they have none.

Example response

[
  {
    "email": "dana@acme.com",
    "name": "Dana Levi",
    "avatar_url": "https://lh3.googleusercontent.com/a/ACg8ocJ2"
  }
]

Changes

Changed in 1 of the 28 revisions of this API.1

Of the 28 revisions, 1 has no diff computed.