Skip to navigation

Lookup user by developer id

Authentication

AuthorizationApi-Key

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

Request

Request body
graph_idstringOptional<=500 characters

The developer-assigned graph ID to resolve to a UUID. Mutually exclusive with user_id and thread_id.

thread_idstringOptional<=500 characters

The developer-assigned thread ID to resolve to a UUID. Mutually exclusive with user_id and graph_id.

user_idstringOptional<=500 characters

The developer-assigned user ID to resolve to a UUID. Mutually exclusive with thread_id and graph_id.

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