Search…
Users
This object represents a verified user in your instance.

Available requests

  • GET /v1/users/:id
  • GET /v1/users
  • POST /v1/users
  • PATCH/v1/users/:id
  • POST /v1/users/:id/profile_image
  • DEL /v1/users/:id
  • GET /v1/users/:id/oauth_access_tokens/:provider

Example user schema

1
{
2
"id": "user_1oBNj55jOjSK9rOYrT5QHqj7eaK",
3
"object": "user",
4
"username": null,
5
"first_name": "Boss",
6
"last_name": "Clerk",
7
"profile_image_url": "https://images.clerk.services/clerk/default-profile.svg",
8
"primary_email_address_id": "idn_1oBNgISXFbSf5m0uP2Wl0qWtNGX",
9
"primary_phone_number_id": null,
10
"primary_web3_wallet_id": null,
11
"password_enabled": true,
12
"two_factor_enabled": false,
13
"email_addresses": [
14
{
15
"id": "idn_1oBNgISXFbSf5m0uP2Wl0qWtNGX",
16
"object": "email_address",
17
"email_address": "[email protected]",
18
"verification": {
19
"status": "verified",
20
"strategy": "email_code",
21
"attempts": 1,
22
"expire_at": 1612756733
23
},
24
"linked_to": []
25
}
26
],
27
"phone_numbers": [
28
{
29
"id": "idn_1q8Uq8Mc4t7WWMy9Z6Og0gNJVui",
30
"object": "phone_number",
31
"phone_number": "+15555555555",
32
"reserved_for_second_factor": false,
33
"verification": {
34
"status": "verified",
35
"strategy": "phone_code",
36
"attempts": 1,
37
"expire_at": 1616461499
38
},
39
"linked_to": []
40
}
41
],
42
"web3_wallets": [
43
{
44
"id": "idn_23xyKkHEPpQQk9RzTCJVHsKoOTW",
45
"object": "web3_wallet",
46
"web3_wallet": "0x0000000000000000000000000000000000000000",
47
"verification": {
48
"status": "verified",
49
"strategy": "web3_metamask_signature",
50
"attempts": 1,
51
"expire_at": 1642690572653,
52
"nonce": "foz4bbtrtw283h0bz72r101d9t9uyjdyx0t84krg"
53
}
54
}
55
],
56
"external_accounts": [],
57
"public_metadata": {},
58
"private_metadata": {},
59
"created_at": 1612756155,
60
"updated_at": 1612756155
61
}
Copied!

get
https://api.clerk.dev
/v1/users/:id
Retrieve a user
get
https://api.clerk.dev
/v1/users
List all users
post
https://api.clerk.dev
/v1/users
Create a user
patch
https://api.clerk.dev
/v1/users/:id
Update a user
post
https://clerk.example.com
/v1/users/:id/profile_image
Update a user's profile image
delete
https://api.clerk.dev
/v1/users/:id
Delete a user
get
https://api.clerk.dev/
v1/users/:id/oauth_access_tokens/:provider
Retrieve OAuth access token for a user
Last modified 6d ago