curl --request POST \
  --url https://{domain}-be.glean.com/rest/api/v1/listentities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filter": [
    {
      "fieldName": "type",
      "values": [
        {
          "value": "Spreadsheet",
          "relationType": "EQUALS"
        },
        {
          "value": "Presentation",
          "relationType": "EQUALS"
        }
      ]
    }
  ],
  "sort": [
    {
      "orderBy": "ASC",
      "sortBy": "<string>"
    }
  ],
  "entityType": "PEOPLE",
  "datasource": "<string>",
  "query": "<string>",
  "includeFields": [
    "PEOPLE"
  ],
  "pageSize": 100,
  "cursor": "<string>",
  "source": "<string>"
}'
{
  "results": [
    {
      "name": "George Clooney",
      "obfuscatedId": "abc123"
    }
  ],
  "teamResults": [
    {
      "relatedObjects": {},
      "permissions": {
        "write": {
          "scopeType": "GLOBAL",
          "create": true,
          "update": true,
          "delete": true
        }
      },
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "businessUnit": "<string>",
      "department": "<string>",
      "photoUrl": "<string>",
      "bannerUrl": "<string>",
      "externalLink": "<string>",
      "members": [
        {
          "person": {
            "name": "George Clooney",
            "obfuscatedId": "abc123"
          },
          "relationship": "MEMBER",
          "customRelationshipStr": "<string>",
          "joinDate": "2023-11-07T05:31:56Z"
        }
      ],
      "memberCount": 123,
      "emails": [
        {
          "email": "jsmith@example.com",
          "type": "PRIMARY",
          "isUserGenerated": true
        }
      ],
      "datasourceProfiles": [
        {
          "datasource": "github",
          "handle": "<string>",
          "url": "<string>",
          "nativeAppUrl": "<string>",
          "isUserGenerated": true
        }
      ],
      "datasource": "<string>",
      "createdFrom": "<string>",
      "lastUpdatedAt": "2023-11-07T05:31:56Z",
      "status": "PROCESSED",
      "canBeDeleted": true,
      "loggingId": "<string>"
    }
  ],
  "customEntityResults": [
    {
      "permissions": {
        "write": {
          "scopeType": "GLOBAL",
          "create": true,
          "update": true,
          "delete": true
        }
      },
      "id": "<string>",
      "title": "<string>",
      "datasource": "<string>",
      "objectType": "<string>",
      "metadata": {
        "customData": {}
      },
      "roles": [
        {
          "sourceDocumentSpec": {
            "url": "<string>"
          },
          "person": {
            "name": "George Clooney",
            "obfuscatedId": "abc123"
          },
          "group": {
            "type": "DEPARTMENT",
            "id": "<string>",
            "name": "<string>"
          },
          "role": "OWNER"
        }
      ]
    }
  ],
  "facetResults": [
    {
      "sourceName": "container_name",
      "operatorName": "SelectMultiple",
      "buckets": [
        {
          "count": 1,
          "datasource": "jira",
          "percentage": 5,
          "value": {
            "stringValue": "engineering",
            "integerValue": 5,
            "displayLabel": "engineering",
            "iconConfig": {
              "color": "#343CED",
              "key": "person_icon",
              "iconType": "GLYPH",
              "name": "user"
            }
          }
        }
      ],
      "hasMoreBuckets": false,
      "groupName": "Service Cloud"
    }
  ],
  "cursor": "<string>",
  "totalCount": 123,
  "hasMoreResults": true,
  "sortOptions": [
    "ENTITY_NAME"
  ],
  "customFacetNames": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Scio-Actas
string

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

X-Glean-Auth-Type
string

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

Body

application/json
List people request
filter
object[]
sort
object[]

Use EntitiesSortOrder enum for SortOptions.sortBy

entityType
enum<string>
default:PEOPLE
Available options:
PEOPLE,
TEAMS,
CUSTOM_ENTITIES
datasource
string

The datasource associated with the entity type, most commonly used with CUSTOM_ENTITIES

query
string

A query string to search for entities that each entity in the response must conform to. An empty query does not filter any entities.

includeFields
enum<string>[]

List of entity fields to return (that aren't returned by default)

Available options:
PEOPLE,
TEAMS,
PEOPLE_DISTANCE,
PERMISSIONS,
FACETS,
INVITE_INFO,
LAST_EXTENSION_USE,
MANAGEMENT_DETAILS,
UNPROCESSED_TEAMS
pageSize
integer

Hint to the server about how many results to send back. Server may return less.

Example:

100

cursor
string

Pagination cursor. A previously received opaque token representing the position in the overall results at which to start.

source
string

A string denoting the search surface from which the endpoint is called.

Response

200
application/json
OK
results
object[]
teamResults
object[]
customEntityResults
object[]
facetResults
object[]
cursor
string

Pagination cursor. A previously received opaque token representing the position in the overall results at which to start.

totalCount
integer

The total number of entities available

hasMoreResults
boolean

Whether or not more entities can be fetched.

sortOptions
enum<string>[]

Sort options from EntitiesSortOrder supported for this response. Default is empty list.

Different ways of sorting entities

Available options:
ENTITY_NAME,
FIRST_NAME,
LAST_NAME,
ORG_SIZE_COUNT,
START_DATE,
TEAM_SIZE,
RELEVANCE
customFacetNames
string[]

list of Person attributes that are custom setup by deployment