List entities

post/listentities

List some set of details for all entities that fit the given criteria and return in the requested order. Does not support negation in filters, assumes relation type EQUALS. There is a limit of 10000 entities that can be retrieved via this endpoint, except when using FULL_DIRECTORY request type for people entities.

SecurityBearerAuth
Request
header Parameters
X-Glean-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).

X-Glean-Auth-Type
string

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

Request Body schema: application/json
required

List people request

cursor
string

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

datasource
string

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

entityType
string
Default: "PEOPLE"
Enum: "PEOPLE" "TEAMS" "CUSTOM_ENTITIES"
Array of objects (FacetFilter)
includeFields
Array of strings

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

Items Enum: "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.

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.

requestType
string
Default: "STANDARD"

The type of request being made.

Enum: Description
STANDARD

Used by default for all requests and satisfies all standard use cases for list requests. Limited to 10000 entities.

FULL_DIRECTORY

Used exclusively to return a comprehensive list of all people entities in the organization, typically for audit like purposes. The recommended approach is to sort by FIRST_NAME or LAST_NAME, and use pagination for large organizations.

Array of objects (SortOptions)

Use EntitiesSortOrder enum for SortOptions.sortBy

source
string

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

Responses
200

OK

Response Schema: application/json
cursor
string

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

Array of objects (CustomEntity)
customFacetNames
Array of strings

list of Person attributes that are custom setup by deployment

Array of objects (FacetResult)
hasMoreResults
boolean

Whether or not more entities can be fetched.

Array of objects (Person)
sortOptions
Array of strings (EntitiesSortOrder)

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

Items Enum: "ENTITY_NAME" "FIRST_NAME" "LAST_NAME" "ORG_SIZE_COUNT" "START_DATE" "TEAM_SIZE" "RELEVANCE"
Array of objects (Team)
totalCount
integer

The total number of entities available

400

Invalid request

401

Not Authorized

429

Too Many Requests

Request samples
application/json
{
  • "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",
  • "requestType": "STANDARD"
}
Response samples
application/json
{
  • "results": [
    • {
      • "name": "George Clooney",
      • "obfuscatedId": "abc123"
      }
    ],
  • "teamResults": [
    • {
      • "relatedObjects": {
        • "property1": {
          • "objects": [
            • {
              • "id": "string",
              • "metadata": {
                • "name": null
                }
              }
            ]
          },
        • "property2": {
          • "objects": [
            • {
              • "id": "string",
              • "metadata": {
                • "name": null
                }
              }
            ]
          }
        },
      • "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": "http://example.com",
      • "members": [
        • {
          • "person": {
            • "name": "George Clooney",
            • "obfuscatedId": "abc123"
            },
          • "relationship": "MEMBER",
          • "customRelationshipStr": "string",
          • "joinDate": "2019-08-24T14:15:22Z"
          }
        ],
      • "memberCount": 0,
      • "emails": [
        • {
          • "email": "user@example.com",
          • "type": "PRIMARY",
          • "isUserGenerated": true
          }
        ],
      • "customFields": [
        • {
          • "label": "string",
          • "values": [
            • {
              • "strText": "string"
              }
            ],
          • "displayable": true
          }
        ],
      • "datasourceProfiles": [
        • {
          • "datasource": "github",
          • "handle": "string",
          • "url": "string",
          • "nativeAppUrl": "string",
          • "isUserGenerated": true
          }
        ],
      • "datasource": "string",
      • "createdFrom": "string",
      • "lastUpdatedAt": "2019-08-24T14:15:22Z",
      • "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": {
          • "property1": {
            • "displayLabel": "string",
            • "stringValue": "string",
            • "stringListValue": [
              • "string"
              ],
            • "numberValue": 0,
            • "booleanValue": true
            },
          • "property2": {
            • "displayLabel": "string",
            • "stringValue": "string",
            • "stringListValue": [
              • "string"
              ],
            • "numberValue": 0,
            • "booleanValue": true
            }
          }
        },
      • "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": 0,
  • "hasMoreResults": true,
  • "sortOptions": [
    • "ENTITY_NAME"
    ],
  • "customFacetNames": [
    • "string"
    ]
}