WorkOS

🚀 Quickstart

Connect to WorkOS with Nango and see data flow in 2 minutes.

Create the integration

In Nango (free signup), go to Integrations -> Configure New Integration -> WorkOS.

Authorize WorkOS

Go to Connections -> Add Test Connection -> Authorize, then enter your API key. Later, you’ll let your users do the same directly from your app.

Call the WorkOS API

Let’s make your first request to the WorkOS API (list connections). Replace the placeholders below with your Environment API key, integration ID, and connection ID:

cURL
Node

curl "https://api.nango.dev/proxy/connections?limit=1" \
  -H "Authorization: Bearer <NANGO-API-KEY>" \
  -H "Provider-Config-Key: <INTEGRATION-ID>" \
  -H "Connection-Id: <CONNECTION-ID>"

Install Nango’s backend SDK with npm i @nangohq/node. Then run:

import { Nango } from '@nangohq/node';

const nango = new Nango({ apiKey: '<NANGO-API-KEY>' });

const res = await nango.get({
    endpoint: '/connections',
    providerConfigKey: '<INTEGRATION-ID>',
    connectionId: '<CONNECTION-ID>',
    params: { limit: '1' }
});

console.log(res.data);

Or fetch credentials with the Node SDK or API.✅ You’re connected! Check the Logs tab in Nango to inspect requests.

Implement Nango in your app

Follow our Auth implementation guide to integrate Nango in your app.To obtain your own production credentials, follow the setup guide linked below.

📚 WorkOS Integration Guides

Nango-maintained guides for common use cases.

How to obtain your WorkOS API key
Get your WorkOS API key to connect it to Nango

Official docs: WorkOS API Reference

🧩 Pre-built syncs & actions for WorkOS

Enable them in your dashboard. Extend and customize to fit your needs.

Others

Function name	Description	Type	Source code
`create-connection`	Create a WorkOS SSO connection.	Action	🔗 Github
`create-invitation`	Create a WorkOS user invitation.	Action	🔗 Github
`create-organization-domain`	Create a WorkOS organization domain.	Action	🔗 Github
`create-organization-membership`	Create a WorkOS organization membership.	Action	🔗 Github
`create-organization`	Create an organization in WorkOS.	Action	🔗 Github
`create-user`	Create a user in WorkOS User Management.	Action	🔗 Github
`deactivate-organization-membership`	Deactivate a WorkOS organization membership.	Action	🔗 Github
`delete-connection`	Delete a WorkOS SSO connection.	Action	🔗 Github
`delete-directory`	Delete a WorkOS directory.	Action	🔗 Github
`delete-organization-domain`	Delete a WorkOS organization domain.	Action	🔗 Github
`delete-organization-membership`	Delete a WorkOS organization membership.	Action	🔗 Github
`delete-organization`	Permanently delete a WorkOS organization.	Action	🔗 Github
`delete-user`	Permanently delete a WorkOS user.	Action	🔗 Github
`get-connection`	Get a WorkOS SSO connection.	Action	🔗 Github
`get-directory-group`	Get a WorkOS directory group.	Action	🔗 Github
`get-directory-user`	Get a WorkOS directory user.	Action	🔗 Github
`get-directory`	Get a WorkOS directory.	Action	🔗 Github
`get-invitation`	Get a WorkOS user invitation.	Action	🔗 Github
`get-organization-domain`	Get a WorkOS organization domain.	Action	🔗 Github
`get-organization-membership`	Get a WorkOS organization membership.	Action	🔗 Github
`get-organization`	Retrieve a WorkOS organization by ID.	Action	🔗 Github
`get-user`	Retrieve a WorkOS user by ID.	Action	🔗 Github
`list-connections`	List WorkOS SSO connections.	Action	🔗 Github
`list-directories`	List WorkOS directories.	Action	🔗 Github
`list-directory-groups`	List directory groups from WorkOS Directory Sync.	Action	🔗 Github
`list-directory-users`	List directory users from WorkOS Directory Sync.	Action	🔗 Github
`list-events`	List WorkOS events.	Action	🔗 Github
`list-invitations`	List WorkOS user invitations.	Action	🔗 Github
`list-organization-membership-groups`	List groups assigned to a WorkOS organization membership.	Action	🔗 Github
`list-organization-memberships`	List WorkOS organization memberships.	Action	🔗 Github
`list-organizations`	List organizations from WorkOS.	Action	🔗 Github
`list-users`	List users from WorkOS User Management.	Action	🔗 Github
`reactivate-organization-membership`	Reactivate a WorkOS organization membership.	Action	🔗 Github
`resend-invitation`	Resend a WorkOS user invitation.	Action	🔗 Github
`revoke-invitation`	Revoke a WorkOS user invitation.	Action	🔗 Github
`update-connection`	Update a WorkOS SSO connection.	Action	🔗 Github
`update-organization-membership`	Update roles for a WorkOS organization membership.	Action	🔗 Github
`update-organization`	Update a WorkOS organization.	Action	🔗 Github
`update-user`	Update a WorkOS user.	Action	🔗 Github
`verify-organization-domain`	Verify a WorkOS organization domain.	Action	🔗 Github

Overview

1,000+ APIs & Integrations

🚀 Quickstart

📚 WorkOS Integration Guides

🧩 Pre-built syncs & actions for WorkOS

Others

​🚀 Quickstart

​📚 WorkOS Integration Guides

​🧩 Pre-built syncs & actions for WorkOS

​Others

🚀 Quickstart

📚 WorkOS Integration Guides

🧩 Pre-built syncs & actions for WorkOS

Others