Skip to main content
GET
/
api
/
v1
/
user
/
{account}
curl --request GET \
    --url http://localhost:8000/api/v1/user/johndoe \
    --header "Authorization: Bearer <your_access_token>" \
    | jq

{
  "name": "<string>",
  "email": "jsmith@example.com",
  "account": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "roles": "user",
  "is_active": true,
  "is_verified": true,
  "is_superuser": false,
  "bio": "<string>",
  "dob": "2023-12-25",
  "phone": "<string>",
  "avatar_photo_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deleted_at": "2023-12-25",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
curl --request GET \
    --url http://localhost:8000/api/v1/user/johndoe \
    --header "Authorization: Bearer <your_access_token>" \
    | jq

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
account
string
required

Response

Successful Response

Public user schema (excludes sensitive information).

​
name
string
required
Required string length: 8 - 40
​
email
string<email>
required
Maximum string length: 255
​
account
string
required
Maximum string length: 32
​
id
string<uuid>
required
​
roles
enum<string>
default:user

User role enumeration.

Available options:
user,
admin
​
is_active
boolean
default:true
​
is_verified
boolean
default:true
​
is_superuser
boolean
default:false
​
bio
string | null
Maximum string length: 200
​
dob
string<date> | null
​
phone
string | null
Maximum string length: 20
​
avatar_photo_id
string<uuid> | null
​
deleted_at
string<date> | null
​
created_at
string<date-time>
​
updated_at
string<date-time>