Users

Search…

Users

This object represents a verified user in your instance.  
Available requests
GET  /v1/users/:id
GET  /v1/users
GET  /v1/users/count
POST /v1/users
PATCH/v1/users/:id
PATCH/v1/users/:id/metadata
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
    "external_id": "my_previous_auth_solution_id",
5
    "username": null,
6
    "first_name": "Boss",
7
    "last_name": "Clerk",
8
    "profile_image_url": "https://images.clerk.services/clerk/default-profile.svg",
9
    "primary_email_address_id": "idn_1oBNgISXFbSf5m0uP2Wl0qWtNGX",
10
    "primary_phone_number_id": null,
11
    "primary_web3_wallet_id": null,
12
    "password_enabled": true,
13
    "two_factor_enabled": false,
14
    "email_addresses": [
15
        {
16
            "id": "idn_1oBNgISXFbSf5m0uP2Wl0qWtNGX",
17
            "object": "email_address",
18
            "email_address": "[email protected]",
19
            "verification": {
20
                "status": "verified",
21
                "strategy": "email_code",
22
                "attempts": 1,
23
                "expire_at": 1612756733
24
            },
25
            "linked_to": []
26
        }
27
    ],
28
    "phone_numbers": [
29
        {
30
            "id": "idn_1q8Uq8Mc4t7WWMy9Z6Og0gNJVui",
31
            "object": "phone_number",
32
            "phone_number": "+15555555555",
33
            "reserved_for_second_factor": false,
34
            "verification": {
35
                "status": "verified",
36
                "strategy": "phone_code",
37
                "attempts": 1,
38
                "expire_at": 1616461499
39
            },
40
            "linked_to": []
41
        }
42
    ],
43
    "web3_wallets": [
44
        {
45
            "id": "idn_23xyKkHEPpQQk9RzTCJVHsKoOTW",
46
            "object": "web3_wallet",
47
            "web3_wallet": "0x0000000000000000000000000000000000000000",
48
            "verification": {
49
                "status": "verified",
50
                "strategy": "web3_metamask_signature",
51
                "attempts": 1,
52
                "expire_at": 1642690572653,
53
                "nonce": "foz4bbtrtw283h0bz72r101d9t9uyjdyx0t84krg"
54
            }
55
        }
56
    ],
57
    "external_accounts": [],
58
    "public_metadata": {},
59
    "private_metadata": {},
60
    "created_at": 1612756155,
61
    "updated_at": 1612756155
62
}
Copied!
​
get
https://api.clerk.dev
/v1/users/:id
Retrieve a user
get
https://api.clerk.dev
/v1/users
List all users
get
https://api.clerk.dev
/v1/users/count
Count users
post
https://api.clerk.dev
/v1/users
Create a user
patch
https://api.clerk.dev
/v1/users/:id
Update a user
patch
https://api.clerk.dev
/v1/users/:id/metadata
Merge and update a user's metadata
post
https://clerk.example.com
/v1/users/:id/profile_image
Set 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 the OAuth access token of a user