Users

List users

Changed on

List the users in the Glean directory, ordered by display_name and then by user_id. The list includes the same people as the Glean People directory. Inactive users, such as former employees, are left out unless an is_active filter includes the value "false". Use the returned user_id values with other Platform APIs, for example as usage limit targets.

get/api/users

Request

  • Base URL: https://instance-name-be.glean.com
  • URL: https://instance-name-be.glean.com/api/users
  • Auth: HTTP bearer

Query parameters

page_sizeinteger

Maximum number of users to return. Defaults to 50. Maximum is 100.

cursorstring

Opaque pagination cursor from a previous response. Send the same filters that the previous request used.

JSON-encoded filters that choose which users are returned. The only supported field is is_active, with the values "true" and "false" and the operator EQUALS. Multiple values OR within a filter. Multiple filters AND together. Without an is_active filter, only active users are returned. To return active and inactive users, send [{"field":"is_active","values":["true","false"]}].

includePlatformUserInclude[]

Optional fields to add to each user. Each value only adds fields; it does not change which users are returned.

Response

Successful response.

has_moreboolean required

Whether more users are available after this page.

next_cursorstring nullable

Opaque cursor for the next page; null or absent when has_more is false.

request_idstring required

Request identifier for correlating this response.

Changes