WorkOS.Events (WorkOS SDK for Elixir v3.0.1)

Copy Markdown View Source

Operations for the Events API.

Summary

Functions

list_events(client, params \\ %{}, opts \\ [])

@spec list_events(WorkOS.Client.t(), map(), keyword()) ::
  {:ok, WorkOS.Page.t(WorkOS.EventSchema.t())} | {:error, WorkOS.Error.error()}

List events

List events for the current environment.

Parameters

  • params — query parameters: :before, :after_, :limit, :order, :events, :range_start, :range_end, :organization_id
  • opts — per-request options (see WorkOS.Client.request/5)