v68

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0170379386.9 KB

Entities

Read people

Read people details for the given IDs.

post/rest/api/v1/people

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.

Headers

X-Glean-ActAsstring 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-Typestring

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

Request body

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

errorsstring[]

A list of IDs that could not be found.