How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Clerk

Clerk Users API

The user object represents a user that has successfully signed up to your application.

Documentation Provider Profile APIs.io OpenAPI GitHub

Clerk Users API is one of 104 APIs that Clerk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 35 operations across 30 paths, and defines 59 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.clerk.com/v1.

35 operations 30 paths 59 schemas 9 DELETE9 GET2 PATCH15 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.clerk.com/v1
Authentication
HTTP Bearer, HTTP Bearer
Contact
Clerk Platform Team
License
MIT
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Clerk Users API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (sk__) (bearerAuth). It accepts HTTP bearer tokens (platform_api_access_token).

  • bearerAuth — Secret key, obtained under "API Keys" in the Clerk Dashboard.
  • platform_api_access_token — Platform API access token.

Paths & Operations 35

Across 30 paths, the API surfaces 35 operations — 9 DELETE, 9 GET, 2 PATCH, 15 POST. Each is listed below with its method, path, parameters, and response codes.

Users 35

The user object represents a user that has successfully signed up to your application.

GET
/users
List All Users
GetUserList 25 params → 200400401422
POST
/users
Create a New User
CreateUser body → 200400401403422
GET
/users/count
Count Users
GetUsersCount 22 params → 200422
GET
/users/{user_id}
Retrieve a User
GetUser 1 param → 200400401404
PATCH
/users/{user_id}
Update a User
UpdateUser 1 param body → 200400401404409422
DELETE
/users/{user_id}
Delete a User
DeleteUser 1 param → 200400401404
POST
/users/{user_id}/ban
Ban a User
BanUser 1 param → 200402
POST
/users/{user_id}/unban
Unban a User
UnbanUser 1 param → 200402
POST
/users/ban
Ban Multiple Users
UsersBan body → 200400402
POST
/users/unban
Unban Multiple Users
UsersUnban body → 200400402
POST
/users/{user_id}/lock
Lock a User
LockUser 1 param → 200403
POST
/users/{user_id}/unlock
Unlock a User
UnlockUser 1 param → 200403
POST
/users/{user_id}/profile_image
Set User Profile Image
SetUserProfileImage 1 param body → 200400401404
DELETE
/users/{user_id}/profile_image
Delete User Profile Image
DeleteUserProfileImage 1 param → 200404
PATCH
/users/{user_id}/metadata
Merge and Update a User's Metadata
UpdateUserMetadata 1 param body → 200400401404422
GET
/users/{user_id}/billing/subscription
Retrieve a User's Billing Subscription
GetUserBillingSubscription 1 param → 200400401403404422500
GET
/users/{user_id}/billing/credits
Retrieve a User's Credit Balance
GetUserBillingCreditBalance 1 param → 200400401403404422500
POST
/users/{user_id}/billing/credits
Adjust a User's Credit Balance
AdjustUserBillingCreditBalance 1 param body → 200400401403404409422500
GET
/users/{user_id}/oauth_access_tokens/{provider}
Retrieve the OAuth Access Token of a User
GetOAuthAccessToken 5 params → 200400404422
GET
/users/{user_id}/organization_memberships
Retrieve All Memberships for a User
UsersGetOrganizationMemberships 3 params → 200403
GET
/users/{user_id}/organization_invitations
Retrieve All Invitations for a User
UsersGetOrganizationInvitations 4 params → 200400403404
POST
/users/{user_id}/verify_password
Verify the Password of a User
VerifyPassword 1 param body → 200400404422500
POST
/users/{user_id}/verify_totp
Verify a TOTP or Backup Code for a User
VerifyTOTP 1 param body → 200400404422500
DELETE
/users/{user_id}/mfa
Disable a User's MFA Methods
DisableMFA 1 param → 200404500
DELETE
/users/{user_id}/backup_code
Disable All User's Backup Codes
DeleteBackupCode 1 param → 200404500
DELETE
/users/{user_id}/passkeys/{passkey_identification_id}
Delete a User Passkey
UserPasskeyDelete 2 params → 200403404500
DELETE
/users/{user_id}/web3_wallets/{web3_wallet_identification_id}
Delete a User Web3 Wallet
UserWeb3WalletDelete 2 params → 200400403404500
DELETE
/users/{user_id}/totp
Delete All the User's TOTPs
DeleteTOTP 1 param → 200404500
DELETE
/users/{user_id}/external_accounts/{external_account_id}
Delete External Account
DeleteExternalAccount 2 params → 200400403404500
POST
/users/{user_id}/password/set_compromised
Set a User's Password as Compromised
SetUserPasswordCompromised 1 param body → 200400401403404422
POST
/users/{user_id}/password/unset_compromised
Unset a User's Password as Compromised
UnsetUserPasswordCompromised 1 param → 200400401403404422
GET
/platform/applications/{applicationID}/instances/{envOrInsID}/users
List Instance Users
PlatformListInstanceUsers 6 params → 200400401403404422
DELETE
/platform/applications/{applicationID}/instances/{envOrInsID}/users/{userID}
Delete a User
PlatformDeleteUser 3 params → 200400401403404
POST
/platform/applications/{applicationID}/instances/{envOrInsID}/users/{userID}/ban
Ban a User
PlatformBanUser 3 params → 200400401403404
POST
/platform/applications/{applicationID}/instances/{envOrInsID}/users/{userID}/unban
Unban a User
PlatformUnbanUser 3 params → 200400401403404

Schemas 59

The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are User (46 properties), CommerceSubscriptionItem (26 properties), CommercePlan (19 properties), ExternalAccountWithVerification (19 properties). Each schema is shown below with its type and property counts.

CommerceTotalsResponse
object
6 properties 4 required
EmailAddress
object
9 properties 7 required
verification_email_link
object
6 properties 4 required
OrganizationInvitationPublicOrganizationData
object
5 properties 4 required
FeatureResponse
object
6 properties 6 required
OrganizationInvitationWithPublicOrganizationData
object
An organization invitation with public organization data populated
12 required
verification_saml
object
8 properties 3 required
CommerceMoneyResponse
object
4 properties 4 required
CommerceSubscriptionItem
object
26 properties 13 required
CommerceSubscriptionCreditResponse
object
2 properties
CommercePayerCreditResponse
object
2 properties 2 required
Web3Wallet
object
6 properties 5 required
CommercePayerResponse
object
13 properties 3 required
TotalCount
object
2 properties 2 required
DeletedObject
object
5 properties 2 required
IdentificationLink
object
2 properties 2 required
ExternalAccountWithVerification
object
19 properties 13 required
CommerceCreditsResponse
object
3 properties 3 required
verification_from_oauth
object
7 properties 4 required
CommerceSubscriptionItemSeatsResponse
object
2 properties 1 required
CommercePlanUnitPrice
object
3 properties 3 required
verification_otp
object
6 properties 4 required
SAMLAccountConnection
object
12 properties 7 required
OrganizationMembership
object
A user's membership in an organization
11 properties 8 required
OrganizationInvitationsWithPublicOrganizationData
object
2 properties 2 required
CommerceSubscription
object
12 properties 10 required
ClerkError
object
4 properties 3 required
CommercePlanUnitPriceTier
object
3 properties 2 required
verification_admin
object
6 properties 4 required
EnterpriseAccount
object
14 properties 6 required
CommercePlan
object
19 properties 17 required
verification_oauth
object
8 properties 4 required
ClerkErrors
object
3 properties 1 required
Organization
object
18 properties 10 required
verification_ticket
object
6 properties 4 required
verification_google_one_tap
object
7 properties 4 required
OAuthAccessToken
array
CommerceSubscriptionNextPayment
object
2 properties 2 required
OrganizationMemberships
object
2 properties 2 required
Passkey
object
5 properties 4 required
verification_web3
object
8 properties 4 required
PasswordHasher
string
The hashing algorithm that was used to generate the password digest. The algorithms we support at the moment are [bcrypt](https://en.wikipedia.org/wiki/Bcrypt)…
verification_passkey
object
8 properties 4 required
AdjustCreditBalanceRequest
object
5 properties 3 required
CommercePerUnitTotalTier
object
3 properties 2 required
CommerceProrationCreditDetailResponse
object
4 properties 4 required
CommercePaymentMethodResponse
object
17 properties 10 required
CommercePerUnitTotal
object
3 properties 3 required
OrganizationInvitationPublicUserData
objectnull
An organization inviter's public user data
6 properties 6 required
EnterpriseAccountConnection
object
14 properties 12 required
CommerceSubscriptionItemNextPaymentResponse
object
2 properties
PhoneNumber
object
11 properties 7 required
SAMLAccount
object
12 properties 6 required
SCIMUserMetadata
object
Metadata describing a user's linkage to a SCIM directory. This object is only delivered on user.created and user.updated webhook events, and only when the user…
3 properties 2 required
CommerceCreditBalanceResponse
object
2 properties 2 required
User
object
46 properties 35 required
OrganizationMembershipPublicUserData
object
An organization membership with public user data populated
9 properties 6 required
CommerceCreditLedgerResponse
object
9 properties 8 required
PlatformListInstanceUsersResponse
object
A paginated list of users for an application instance.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

clerk-com-users-api-openapi.yml Raw ↑

Other APIs Clerk publishes across the network.

Clerk Account Portal API
AE Profile APIs.io
Clerk Active Sessions API
AE Profile APIs.io
Clerk Actor Tokens API
AE Profile APIs.io
Clerk Agent Tasks API
AE Profile APIs.io
Clerk Allow-list / Block-list API
AE Profile APIs.io
Clerk API Keys API
AE Profile APIs.io
Clerk Application Transfers API
AE Profile APIs.io
Clerk Applications API
AE Profile APIs.io
Clerk Backup Codes API
AE Profile APIs.io
Clerk Beta Features API
AE Profile APIs.io
Clerk Billing API
AE Profile APIs.io
Clerk Checkouts API
AE Profile APIs.io
#User
← Back to C APIs
API Details
ID
clerk-com:clerk-com-users-api
Base URL
https://api.clerk.com/v1
Docs
https://clerk.com/docs/reference/backend-api
Provider
Clerk
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=clerk-com-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/clerk-com-users-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Clerk Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.