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

WorkOS events API

Query events and event streams.

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

Tagged areas include Event. 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 1 operation across 1 path, and defines 12 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.

1 operations 1 paths 12 schemas 1 GET

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
License
Resource Areas
1

Authentication & Security 2

WorkOS events 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

events 1

Query events and event streams.

GET
/events
List Events
EventsController_list 8 params → 200400422

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are DirectoryUser (19 properties), UserlandUser (13 properties), DirectoryGroup (9 properties), Group (7 properties). Each schema is shown below with its type and property counts.

EventContextActorDto
object
The actor who performed the action.
3 properties 3 required
WaitlistUser
object
7 properties 7 required
EventSchema
An event emitted by WorkOS.
DirectoryUser
object
19 properties 11 required
DirectoryGroup
object
9 properties 8 required
PaginationOrder
string
EventList
object
3 properties 3 required
VaultByokKeyProvider
string
The external key provider used for BYOK.
UserlandUser
object
The user object.
13 properties 11 required
Group
object
7 properties 7 required
EventContextDto
object
Additional context about the event.
6 properties
SlimRole
object
The primary role assigned to the user.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workos-events-api-openapi.yml Raw ↑

Other APIs WorkOS publishes across the network.

WorkOS admin-portal API
WorkOS api_keys API
WorkOS application.client-secrets API
WorkOS applications API
WorkOS audit-logs API
WorkOS authorization API
WorkOS connections API
WorkOS directories API
WorkOS directory-groups API
WorkOS directory-users API
WorkOS feature-flags API
WorkOS feature-flags.targets API
Where this information came from

This is an independent, third-party profile of WorkOS events 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.