Read organizations, directories, users and groups, and create organizations in workflows.
Explore 9 workflow actions for WorkOS, including account permissions and operation limits.
8 read actions1 write action
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Create organization
Write
Create a WorkOS organization with a name and optional external ID.
Permissions and limits
Account permissions
Depends on the connected account and selected operation. Check the service documentation.
Operation limits
Domains and metadata are deliberately not set by this action.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get directory
Read
Read a WorkOS directory by ID.
Permissions and limits
Account permissions
Depends on the connected account and selected operation. Check the service documentation.
Operation limits
Provider setup fields, external keys and directory metadata are excluded.
Get directory group
Read
Read a directory group by ID.
Permissions and limits
Account permissions
Depends on the connected account and selected operation. Check the service documentation.
Operation limits
Raw provider attributes are excluded.
Get directory user
Read
Read a provisioned directory user by ID.
Permissions and limits
Account permissions
Depends on the connected account and selected operation. Check the service documentation.
Operation limits
Email address is returned as identity data. Custom attributes, roles and deprecated group arrays are excluded.
Get organization
Read
Read a WorkOS organization by ID.
Permissions and limits
Account permissions
Depends on the connected account and selected operation. Check the service documentation.
Operation limits
Domain verification tokens and organization metadata are excluded.
List directories
Read
Read one page of WorkOS directories.
Permissions and limits
Account permissions
Depends on the connected account and selected operation. Check the service documentation.
Operation limits
Returns one bounded page. Use list_metadata.before or list_metadata.after for the next page.
Provider setup fields, external keys and directory metadata are excluded.
Pagination: cursor. Check the result for additional pages; a single action may not return every record.
List directory groups
Read
Read one page of directory groups, optionally for one user.
Permissions and limits
Account permissions
Depends on the connected account and selected operation. Check the service documentation.
Operation limits
Returns one bounded page. Use list_metadata.before or list_metadata.after for the next page.
Use the user filter to fetch memberships; raw provider attributes are excluded.
Pagination: cursor. Check the result for additional pages; a single action may not return every record.
List directory users
Read
Read one page of provisioned directory users.
Permissions and limits
Account permissions
Depends on the connected account and selected operation. Check the service documentation.
Operation limits
Returns one bounded page. Use list_metadata.before or list_metadata.after for the next page.
Email addresses are returned as requested identity data. Custom attributes, roles and deprecated group arrays are excluded.
Pagination: cursor. Check the result for additional pages; a single action may not return every record.
List organizations
Read
Read one page of WorkOS organizations.
Permissions and limits
Account permissions
Depends on the connected account and selected operation. Check the service documentation.
Operation limits
Returns one bounded page. Use list_metadata.before or list_metadata.after for the next page.
Domain verification tokens and organization metadata are excluded.
Pagination: cursor. Check the result for additional pages; a single action may not return every record.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in WorkOS. A saved workflow is not a completed provider action.