Skip to navigation
SDK ReferenceUser

Get user by email

Send {"email": "jane@example.com"} to get the user with this email. An email matches only when the stored and requested values are equal after normalization. Normalization lowercases both values and trims leading and trailing whitespace. The operation returns 404 not_found when no active user matches. The operation returns 400 invalid_request with param: "email" when multiple active users match. The operation returns 400 invalid_request with param: "email" when BYOK is active for the account. An email that was stored encrypted with BYOK does not match.

Authentication

AuthorizationApi-Key

Type “Api-Key” followed by a space and the project API key.

Request

Request body
emailstringRequired<=500 characters
The user's email address. Matching ignores case and leading and trailing whitespace.

Response

OK
created_atstringOptional
The time the user was created.
disable_default_ontologybooleanOptional
When true, disables the use of the default fallback ontology for the user's graph.
emailstringOptional
The email address of the user.
first_namestringOptional
The first name of the user.
graph_uuidstringOptional
The unique identifier of the user's graph, populated when the user is created.
last_namestringOptional
The last name of the user.
metadatamap from strings to anyOptional

Arbitrary key-value metadata attached to the user.

time_zonestringOptional
The user's IANA time zone, used to localize dates in generated context.
user_idstringOptional

An optional external identity identifier, such as an identity-provider subject claim. Zep uses it to match an identity-provider sign-in to this user. It is not an address; use uuid to address the user in v4. It is unique within the project, can contain at most 500 characters, and cannot be changed after creation. v4 sets it on create; v3 users keep their existing value.

uuidstringOptional
The unique identifier of the user.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error