WorkOS

WorkOS is an enterprise-grade platform that provides authentication, authorization, and user management infrastructure for B2B SaaS applications. It enables developers to add enterprise features like Single Sign-On (SSO), Directory Sync (SCIM), and multi-tenant organization management to their applications without building these complex systems from scratch.

Category	Identity
Direction	Query source
Sign-in	WorkOS API Key
Query languages	SQLite
Tables	5
Query templates	23
Website	workos.com

Before you start

Huntbase signs in to WorkOS with WorkOS API Key. Create the credential in WorkOS first, then keep it to hand for the Connect step.

1. In the WorkOS Dashboard, open the API Keys section for the environment you want to query.
2. For Staging, copy the key that is already generated. For Production, generate a key and copy it right away: Production keys are viewable only once.

Watch out for

• A key only covers the environment it belongs to. Use the Production key to query production data.

For the vendor's own instructions, see WorkOS API key documentation.

tip

Use a dedicated, read-only credential for Huntbase where the product allows it. Huntbase only needs to read.

Connect WorkOS

1. Go to Connections and click New connection, or click New connection on the WorkOS product page.
2. On Product, pick WorkOS and choose the Owner.
3. On Details, give the connection a Name and, optionally, a Description.
4. On Connect, fill in the settings and credentials described below.
5. On Verify, review the summary and click Create & check.

For everything else on the setup page — saving a draft, I'll do this later, and what each check result means — see Connections.

Credentials

The only Method is WorkOS API Key. Enter a Credential label (for example Production), then fill in:

Field	Required	Notes
WorkOS API Key	Yes	Secret — not shown again after you save it.

Query it

Once connected, WorkOS can serve these languages in a query tab, and Scout can use it when you ask in Auto:

Language	Use it for
SQLite	SQL over the 5 tables listed below, alongside every other connected source.

Example: SQLite

WorkOS groups basic info — List all groups with their unique identifiers, directory, organization, and creation date.

select
  id,
  name,
  directory_id,
  organization_id,
  created_at
from
  workos_group;

WorkOS ships with 23 query templates. Find them in Library › Queries — see Query templates.

What syncs automatically

WorkOS comes with a content pack. These queries run on a schedule on each new connection so the entities they find appear in the Activity Feed without you asking. You can turn syncing off from the connection's Synchronisation Settings card.

Query	Finds
Sync directory users	user
Sync organizations	organization
Sync directories	domain

Tables

WorkOS adds 5 tables. Browse their columns from Schema in the query bar's ⋯ menu.

All 5 tables

Table	Contains
workos_connection	Retrieve information about your connections.
workos_directory	Retrieve information about your directories.
workos_group	Retrieve information about your groups.
workos_organization	Retrieve information about your organizations.
workos_user	Retrieve information about your users.

Next steps

• Connections — health, credentials and settings after you connect
• Query languages — syntax, parameters and time ranges
• Chatting with Scout — ask questions without writing a query
• All integrations — the rest of the catalog