Read people

post/people

Read people details for the given IDs.

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

People request

emailIds
Array of strings

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

includeFields
Array of strings

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

Items Enum: "BADGES" "BUSY_EVENTS" "DOCUMENT_ACTIVITY" "INVITE_INFO" "PEOPLE_DISTANCE" "PERMISSIONS" "PEOPLE_DETAILS" "MANAGEMENT_DETAILS" "PEOPLE_PROFILE_SETTINGS" "PEOPLE_WITHOUT_MANAGER"
includeTypes
Array of strings

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

Items Enum: "PEOPLE_WITHOUT_MANAGER" "INVALID_ENTITIES"
obfuscatedIds
Array of strings

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

source
string

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

timezoneOffset
integer

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

Responses
200

OK

Response Schema: application/json
errors
Array of strings

A list of IDs that could not be found.

Array of objects (RelatedDocuments)

A list of documents related to this people response. This is only included if DOCUMENT_ACTIVITY is requested and only 1 person is included in the request.

Array of objects (Person)

A Person for each ID in the request, each with PersonMetadata populated.

400

Invalid request

401

Not Authorized

429

Too Many Requests

Request samples
application/json
{
  • "obfuscatedIds": [
    • "abc123",
    • "abc456"
    ]
}
Response samples
application/json
{
  • "results": [
    • {
      • "name": "George Clooney",
      • "obfuscatedId": "abc123"
      }
    ],
  • "relatedDocuments": [
    • {
      • "relation": "CASE",
      • "associatedEntityId": "string",
      • "querySuggestion": {
        • "query": "app:github type:pull author:mortimer",
        • "label": "Mortimer's PRs",
        • "datasource": "github"
        },
      • "documents": [
        • {
          • "id": "string",
          • "datasource": "string",
          • "connectorType": "API_CRAWL",
          • "docType": "string",
          • "content": {
            • "fullTextList": [
              • "string"
              ]
            },
          • "containerDocument": { },
          • "parentDocument": { },
          • "title": "string",
          • "url": "string",
          • "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": "someCustomValue"
              }
            },
          • "sections": [
            • {
              • "title": "string",
              • "url": "string"
              }
            ]
          }
        ],
      • "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": [
            • {
              • "missingTerm": "container",
              • "query": "container"
              }
            ]
          }
        ]
      }
    ],
  • "errors": [
    • "string"
    ]
}