⚠️ This documentation pertains to a preview endpoint. This feature is not yet ready for API consumption and may change.
For inquiries or feedback, please contact us at Glean.

Suggest people (admin)

post/peoplesuggestadmin

Returns a list of suggested people for given type for admin's view. Includes information about the persons.

SecurityBearerAuth
Request
header Parameters
X-Glean-Auth-Type
string

Auth type being used to access the endpoint (should be non-empty only for global tokens).

X-Scio-Actas
string <email>

Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).

Request Body schema: application/json
required

Includes request params for type of suggestions.

categories
required
Array of strings (PeopleSuggestionCategory)

Categories of data requested. Request can include single or multiple categories.

Items Enum: "INVITE_INACTIVE_PROMO" "INVITE_NONUSERS"
departments
Array of strings

Departments that the data is requested for. If empty, corresponds to whole company.

Responses
200

OK

Response Schema: application/json
Array of objects (PersonSuggestionList)

Information about people suggestions for asked categories.

400

Invalid request

401

Not Authorized

429

Too Many Requests

Request samples
application/json
{
  • "categories": [
    • "INVITE_INACTIVE_PROMO"
    ],
  • "departments": [
    • "string"
    ]
}
Response samples
application/json
{
  • "suggestions": [
    • {
      • "category": "INVITE_INACTIVE_PROMO",
      • "people": [
        • {
          • "name": "George Clooney",
          • "obfuscatedId": "abc123"
          }
        ]
      }
    ]
}