> ## Documentation Index > Fetch the complete documentation index at: https://docs.airmux.ai/llms.txt > Use this file to discover all available pages before exploring further. # List Workspace Events > List usage events for one workspace with cursor pagination. Required permission: `usage.read`. ## OpenAPI ````yaml /lib/api-spec/openapi.yaml get /api/v1/organizations/{org_id}/workspaces/{workspace_ref}/events openapi: 3.1.0 info: title: airmux Control Plane API description: > Manage airmux organizations, workspaces, management keys, provider credentials, and data-plane synchronization. Organization and workspace targets are part of each URL. Successful responses wrap their result in `{"data": ...}`. Authenticate with a control-plane management key or a browser session as documented by each operation. Inference keys authenticate model requests at the data plane and are not accepted here. version: 0.1.0 servers: [] security: [] tags: - name: Auth description: Sign in human users, manage browser sessions, and authorize the CLI x-displayName: Authentication - name: Enrollment description: List a user's organizations and create their personal organization - name: Instance Organizations description: List and create organizations on this airmux instance x-displayName: Organizations - name: Instance Users description: Manage human users and service accounts across the instance x-displayName: Users - name: Instance Management Keys description: >- List management keys across the instance, issue instance-scoped credentials, and revoke keys x-displayName: Management Keys - name: Instance Model Catalog description: Manage the providers and models available through this airmux instance x-displayName: Model Catalog - name: Instance Provider Credentials description: Manage provider API keys available across the airmux instance x-displayName: Provider Credentials - name: Data Plane Instances description: Inspect connected data-plane instances x-displayName: Data Planes - name: Instance Activity description: Inspect recent audited changes across the instance x-displayName: Activity - name: OSS description: Bootstrap a new self-hosted airmux deployment x-displayName: Self-hosting - name: Organization Settings description: View, update, and delete one organization x-displayName: Settings - name: Organization Members description: Manage organization membership and organization roles x-displayName: Members - name: Organization Service Accounts description: >- Create and delete organization-managed machine principals and their initial management credentials x-displayName: Service Accounts - name: Organization Invitations description: Invite human users to an organization and optionally one workspace x-displayName: Invitations - name: Organization Workspaces description: List and create workspaces within an organization x-displayName: Workspaces - name: Organization Management Keys description: >- List management keys within an organization, issue organization-scoped credentials, and revoke keys x-displayName: Management Keys - name: Organization Provider Credentials description: Manage provider API keys available across an organization x-displayName: Provider Credentials - name: Organization Usage Events description: Inspect usage events across an organization x-displayName: Usage Events - name: Organization Reports description: Explore usage and requests across an organization or one workspace x-displayName: Reports - name: Organization Activity description: Inspect recent audited changes in an organization x-displayName: Activity - name: Organization Model Catalog description: Inspect the provider and model catalog available to an organization x-displayName: Model Catalog - name: Workspace Settings description: View, update, and delete one workspace x-displayName: Settings - name: Workspace Policies description: Manage workspace inference restrictions and fallbacks x-displayName: Policies - name: Workspace Members description: Manage workspace membership and workspace roles x-displayName: Members - name: Workspace Management Keys description: List and issue management keys scoped to a workspace and revoke keys x-displayName: Management Keys - name: Workspace Playground description: Create and end short-lived browser sessions for playground model requests x-displayName: Playground - name: Workspace Inference Keys description: Issue and revoke credentials for model requests to a workspace x-displayName: Inference Keys - name: Workspace Provider Credentials description: Manage provider API keys available to one workspace x-displayName: Provider Credentials - name: Workspace Usage Events description: Inspect usage events for one workspace x-displayName: Usage Events - name: Workspace Model Catalog description: Inspect the provider and model catalog available to a workspace x-displayName: Model Catalog - name: Data Plane API description: Poll bundles, ingest usage events, and record data-plane heartbeats x-displayName: Synchronization paths: /api/v1/organizations/{org_id}/workspaces/{workspace_ref}/events: get: tags: - Workspace Usage Events summary: List Workspace Events description: |- List usage events for one workspace with cursor pagination. Required permission: `usage.read`. operationId: list_workspace_events parameters: - name: workspace_ref in: path required: true schema: type: string title: Workspace Ref description: Workspace ID or slug - name: org_id in: path required: true schema: type: string title: Org Id description: Organization ID or slug - name: cursor in: query required: false schema: anyOf: - $ref: '#/components/schemas/CursorToken' - type: 'null' title: Cursor description: Opaque continuation token from the previous page - name: limit in: query required: false schema: type: integer maximum: 200 minimum: 1 default: 50 title: Limit description: Maximum number of results to return responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PageEnvelope_UsageEventOut_' '401': description: Authentication failed '403': description: The credential does not have the required permission '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - ManagementKey: [] - SessionCookie: [] components: schemas: CursorToken: type: string maxLength: 512 minLength: 1 pattern: ^[A-Za-z0-9_-]+$ PageEnvelope_UsageEventOut_: properties: data: items: $ref: '#/components/schemas/UsageEventOut' type: array maxItems: 200 title: Data page: $ref: '#/components/schemas/PageInfo' type: object required: - data - page title: PageEnvelope[UsageEventOut] HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError UsageEventOut: properties: event_id: type: string format: uuid title: Event Id request_id: type: string format: uuid title: Request Id request_started_at: type: string format: date-time title: Request Started At attempt_started_at: anyOf: - type: string format: date-time - type: 'null' title: Attempt Started At occurred_at: type: string format: date-time title: Occurred At org_id: type: string format: uuid title: Org Id workspace_id: type: string format: uuid title: Workspace Id key_id: type: string title: Key Id request_source: type: string enum: - inference_key - playground title: Request Source user_id: type: string format: uuid title: User Id requested_model_id: type: string title: Requested Model Id requested_capabilities: items: type: string enum: - tools - reasoning - structured_output type: array title: Requested Capabilities model_id: type: string title: Model Id provider_id: type: string title: Provider Id bundle_id: type: string format: uuid title: Bundle Id input_tokens: type: integer title: Input Tokens output_tokens: type: integer title: Output Tokens token_usage_source: $ref: '#/components/schemas/TokenUsageSource' description: >- Token-count provenance: provider, estimated (including partial provider counts), or not_applicable for denials; independent of cost estimates max_output_tokens: anyOf: - type: integer - type: 'null' title: Max Output Tokens cost_usd: type: string pattern: ^\d+(?:\.\d+)?$ title: Cost Usd cost_input_usd: type: string pattern: ^\d+(?:\.\d+)?$ title: Cost Input Usd cost_output_usd: type: string pattern: ^\d+(?:\.\d+)?$ title: Cost Output Usd cache_read_tokens: type: integer title: Cache Read Tokens cache_write_tokens: type: integer title: Cache Write Tokens latency_ms: type: integer title: Latency Ms status: type: string enum: - ok - upstream_error - denied - timeout - cancelled - credential_rejected - rate_limited title: Status stream: type: boolean title: Stream credential_id: anyOf: - type: string format: uuid - type: 'null' title: Credential Id credential_scope: anyOf: - type: string enum: - platform - org - workspace - type: 'null' title: Credential Scope type: object required: - event_id - request_id - request_started_at - attempt_started_at - occurred_at - org_id - workspace_id - key_id - request_source - user_id - requested_model_id - requested_capabilities - model_id - provider_id - bundle_id - input_tokens - output_tokens - token_usage_source - max_output_tokens - cost_usd - cost_input_usd - cost_output_usd - cache_read_tokens - cache_write_tokens - latency_ms - status - stream - credential_id - credential_scope title: UsageEventOut PageInfo: properties: next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor type: object required: - next_cursor title: PageInfo ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError TokenUsageSource: type: string enum: - provider - estimated - not_applicable title: TokenUsageSource securitySchemes: ManagementKey: type: http description: >- A control-plane management key using the `sk-cp-` prefix. Inference keys are not accepted by control-plane endpoints. scheme: bearer SessionCookie: type: apiKey in: cookie name: airmux_session description: >- Browser session cookie returned by login or signup. Browser requests must also send `X-Requested-With`. ````