Sign in

v4

latestOpenAPI 3.0.22026-08-02109239415.7 KB
manage

Get search results for user handles with suggestions for a particular organization.

get/manage/api/organization/user_suggestions

Query parameters

organization_idstring required

Base64 encoded organization ID to get user suggestions for

user_handle_prefixstring

The prefix of the user handle to search for

maxItemsinteger

The maximum number of items to return

Response

A list of the top responses in alphabetical order by user handle + whether the user has joined the current organization already.

Example response

{
  "user_suggestions": [
    {
      "display_handle": "john_doe",
      "joined": false,
      "profile_pic": "https://example.com/avatars/user123.jpg",
      "name": "John Doe"
    },
    {
      "display_handle": "john_doe",
      "joined": false,
      "profile_pic": "https://example.com/avatars/user123.jpg",
      "name": "John Doe"
    }
  ]
}