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
WorkOS

WorkOS user-management.users API

Manage users.

Documentation Provider Profile APIs.io OpenAPI GitHub

WorkOS user-management.users API is one of 41 APIs that WorkOS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User Management - Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a GitHub repository, a changelog, and pricing.

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

Requests are made against 2 base URLs: https://api.workos.com, https://api.workos-test.com.

16 operations 13 paths 16 schemas 1 DELETE7 GET7 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.workos.com
Authentication
HTTP Bearer, HTTP Bearer
Contact
WorkOS
License
MIT
Resource Areas
1

Authentication & Security 2

WorkOS user-management.users API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer). It accepts HTTP bearer tokens (JWT) (access_token). By default, every request must be authenticated.

  • bearer — Your WorkOS API key prefixed with sk. Pass it as a Bearer token: Authorization: Bearer skexample123456789.
  • access_token — An SSO access token returned from the Get a Profile and Token endpoint.

Paths & Operations 16

Across 13 paths, the API surfaces 16 operations — 1 DELETE, 7 GET, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

user-management.users 16

Manage users.

GET
/user_management/email_verification/{id}
Get an Email Verification Code
UserlandUsersController_getEmailVerification 1 param → 200404
POST
/user_management/password_reset
Create a Password Reset Token
UserlandUsersController_createPasswordResetToken body → 201403404422429
POST
/user_management/password_reset/confirm
Reset the Password
UserlandUsersController_resetPassword[0] body → 200400403404422
GET
/user_management/password_reset/{id}
Get a Password Reset Token
UserlandUsersController_getPasswordReset 1 param → 200404
GET
/user_management/users
List Users
UserlandUsersController_list[0] 7 params → 200422
POST
/user_management/users
Create a User
UserlandUsersController_create[0] body → 201400404422
GET
/user_management/users/external_id/{external_id}
Get a User by External ID
UserlandUsersController_getByExternalId 1 param → 200404
PUT
/user_management/users/{id}
Update a User
UserlandUsersController_update[0] 1 param body → 200400422
GET
/user_management/users/{id}
Get a User
UserlandUsersController_get[0] 1 param → 200404
DELETE
/user_management/users/{id}
Delete a User
UserlandUsersController_delete[0] 1 param → 200404
POST
/user_management/users/{id}/email_change/confirm
Confirm Email Change
UserlandUsersController_confirmEmailChange 1 param body → 200400404409422429
POST
/user_management/users/{id}/email_change/send
Send Email Change Code
UserlandUsersController_sendEmailChange 1 param body → 200404409422429
POST
/user_management/users/{id}/email_verification/confirm
Verify Email
UserlandUsersController_emailVerification[0] 1 param body → 200400404422
POST
/user_management/users/{id}/email_verification/send
Send Verification Email
UserlandUsersController_sendVerificationEmail[0] 1 param → 200400404429
GET
/user_management/users/{id}/identities
Get User Identities
UserlandUserIdentitiesController_get 1 param → 200404
GET
/user_management/users/{id}/sessions
List Sessions
UserlandUserSessionsController_list 5 params → 200404422

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are UserlandUser (13 properties), PasswordReset (8 properties), EmailVerification (8 properties), EmailChange (5 properties). Each schema is shown below with its type and property counts.

EmailChange
object
5 properties 5 required
VerifyEmailAddressDto
object
1 property 1 required
ConfirmEmailChangeDto
object
1 property 1 required
PasswordReset
object
8 properties 8 required
UpdateUserlandUserDto
EmailVerification
object
8 properties 8 required
SendEmailChangeDto
object
1 property 1 required
SendVerificationEmailResponse
object
1 property 1 required
ResetPasswordResponse
object
1 property 1 required
CreatePasswordResetDto
object
2 properties 2 required
UserlandUser
object
The user object.
13 properties 11 required
VerifyEmailResponse
object
1 property 1 required
UserlandUserList
object
3 properties 3 required
CreatePasswordResetTokenDto
object
1 property 1 required
PaginationOrder
string
CreateUserlandUserDto

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workos-user-management-users-api-openapi.yml Raw ↑

Other APIs WorkOS publishes across the network.

WorkOS admin-portal API
AE Profile APIs.io
WorkOS api_keys API
AE Profile APIs.io
WorkOS application.client-secrets API
AE Profile APIs.io
WorkOS applications API
AE Profile APIs.io
WorkOS audit-logs API
AE Profile APIs.io
WorkOS authorization API
AE Profile APIs.io
WorkOS connections API
AE Profile APIs.io
WorkOS directories API
AE Profile APIs.io
WorkOS directory-groups API
AE Profile APIs.io
WorkOS directory-users API
AE Profile APIs.io
WorkOS events API
AE Profile APIs.io
WorkOS feature-flags API
AE Profile APIs.io
#User Management - Users
← Back to W APIs
API Details
ID
workos:workos-user-management-users-api
Base URL
https://api.workos.com
Docs
https://workos.com
Provider
WorkOS
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=workos-user-management-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/workos-user-management-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 WorkOS user-management.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.