Entities

Read people

Changed on

Read people details for the given IDs.

post/rest/api/v1/people

Request

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

Query parameters

localestring

The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

Request body

fallbackToAuthenticatedIdentityboolean

If true and the current user's people profile is missing, reads the stored SSO profile and returns a minimal Person with its display name, the authenticated user's email, the same obfuscatedId used by a normal self-lookup, and identityOnly set to true. If the SSO profile or its name is unavailable, preserves the missing-profile error. Applies only when emailIds and obfuscatedIds are empty and the request doesn't use act-as, a virtual identity, anonymous authentication, or the INVALID_ENTITIES includeType. The fallback doesn't mask lookup or enrichment errors and doesn't create a directory profile. Normal people profiles don't require an SSO lookup.

timezoneOffsetinteger

The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.

obfuscatedIdsstring[]

The Person IDs to retrieve. If no IDs are requested, the current user's details are returned.

emailIdsstring[]

The email IDs to retrieve. The result is the deduplicated union of emailIds and obfuscatedIds.

includeFieldsstring[]

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

includeTypesstring[]

The types of people entities to include in the response in addition to those returned by default.

sourcestring

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

Example request

{
  "obfuscatedIds": [
    "abc123",
    "abc456"
  ]
}

Response

OK

errorsstring[]

A list of IDs that could not be found.

Example response

{
  "results": [
    {
      "name": "George Clooney",
      "obfuscatedId": "abc123"
    }
  ],
  "relatedDocuments": [
    {
      "querySuggestion": {
        "query": "app:github type:pull author:mortimer",
        "label": "Mortimer's PRs",
        "datasource": "github"
      },
      "documents": [
        {
          "metadata": {
            "container": "container",
            "parentId": "JIRA_EN-1337",
            "createTime": "2000-01-23T04:56:07.000Z",
            "datasource": "datasource",
            "author": {
              "name": "name"
            },
            "documentId": "documentId",
            "updateTime": "2000-01-23T04:56:07.000Z",
            "mimeType": "mimeType",
            "objectType": "Feature Request",
            "components": [
              "Backend",
              "Networking"
            ],
            "status": "Done",
            "customData": {
              "someCustomField": {
                "stringValue": "someCustomValue"
              }
            }
          }
        }
      ],
      "results": [
        {
          "snippets": [
            {
              "snippet": "snippet",
              "mimeType": "mimeType"
            }
          ],
          "metadata": {
            "container": "container",
            "createTime": "2000-01-23T04:56:07.000Z",
            "datasource": "datasource",
            "author": {
              "name": "name"
            },
            "documentId": "documentId",
            "updateTime": "2000-01-23T04:56:07.000Z",
            "mimeType": "mimeType",
            "objectType": "objectType"
          },
          "title": "title",
          "url": "https://example.com/foo/bar",
          "nativeAppUrl": "slack://foo/bar",
          "mustIncludeSuggestions": {
            "suggestions": [
              {
                "missingTerm": "container",
                "query": "container"
              }
            ]
          }
        }
      ]
    }
  ]
}

Changes

  • 8157502b236fRevision changes
    • info

      added the optional property ///// to the response with the status

  • 31c4fd74a143Revision changes
    • warning

      added the new VIDEO_TYPE enum value to the ///////// response property for the response status

    • warning

      added the new VIDEO_TYPE enum value to the /////////// response property for the response status

    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status