WorkOS API Documentation

This is the complete API documentation for connecting to the WorkOS API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,400+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet WorkOS: WorkOS provides enterprise-ready APIs for user management, organizations, SSO, directory sync, audit logs, RBAC authorization, feature flags, webhooks, Radar risk checks, and related administrative workflows. Keep reading to get started.

Quickstart

Before you run your first WorkOS request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one WorkOS connection — create or choose one in Connections. Note its connectionId.

Every WorkOS action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/workOS/actions/{actionSlug}/run

You need a MindCloud API Key and a WorkOS connection. Then call an action such as List Organizations:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/workOS/actions/list-organizations/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your WorkOS account. See WorkOS API Authentication for the full flow and how to get your connection credentials.

WorkOS actions

All 60 published actions for this WorkOS version. Each page documents the endpoint, arguments, and response controls.

• POSTAssign a role
• POSTCheck authorization
• POSTCreate a password reset token
• POSTCreate a permission
• POSTCreate a user
• POSTCreate a Webhook Endpoint
• POSTCreate an Organization
• POSTCreate an Organization Domain
• POSTCreate an organization membership
• PUTDeactivate an organization membership
• DELETEDelete a Connection
• DELETEDelete a user
• DELETEDelete a Webhook Endpoint
• DELETEDelete an Organization Domain
• DELETEDelete an organization membership
• GETGet a Connection
• GETGet a Directory
• GETGet a Directory Group
• GETGet a Directory User
• GETGet a feature flag
• GETGet a password reset token
• GETGet a permission
• GETGet a user
• GETGet a user by external ID
• GETGet an invitation
• GETGet an Organization
• GETGet an Organization by External ID
• GETGet an Organization Domain
• GETGet an organization membership
• GETGet Audit Log Configuration
• GETGet Retention
• GETGet user identities
• GETList Connections
• GETList Directories
• GETList Directory Groups
• GETList Directory Users
• GETList events
• GETList feature flags
• GETList invitations
• GETList organization memberships
• GETList Organizations
• GETList permissions
• GETList role assignments
• GETList sessions
• GETList users
• GETList Webhook Endpoints
• PUTReactivate an organization membership
• DELETERemove a role assignment
• POSTResend an invitation
• POSTRevoke an invitation
• POSTSend an invitation
• POSTSend verification email
• PUTSet Retention
• PUTUpdate a permission
• PUTUpdate a user
• PUTUpdate a Webhook Endpoint
• PUTUpdate an Organization
• PUTUpdate an organization membership
• POSTVerify an Organization Domain
• POSTVerify email

Related apps

More apps on the Universal API, behind the same REST shape. Or browse all apps.

Google SheetsGmailSlackGoogle CalendarGoogle DriveNotionGoogle FormsMailchimp