Skip to main content
GET
/
v1
/
users
Get User
curl --request GET \
  --url https://api.example.com/v1/users/
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "is_active": true,
  "is_superuser": false,
  "is_verified": false,
  "given_name": "<string>",
  "family_name": "<string>",
  "external_user_id": "<string>",
  "profile_image": "<string>",
  "password_change_required": false,
  "is_super_admin": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.vijil.ai/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

​
email
string | null

Email address of the user to retrieve

Response

Successful Response

Returned to clients when reading user info.

​
id
string<uuid>
required
​
email
string<email>
required
​
is_active
boolean
default:true
​
is_superuser
boolean
default:false
​
is_verified
boolean
default:false
​
given_name
string | null
​
family_name
string | null
​
external_user_id
string | null
​
profile_image
string<uri> | null
Required string length: 1 - 2083
​
password_change_required
boolean
default:false
​
is_super_admin
boolean
default:false
Last modified on April 21, 2026