Skip to main content

Get started with the 1Password Events API Beta

info

This content is for testing the v3 audit events beta endpoint. See how to get started with the production version (v2) if you don't want to use the beta.

You can use the 1Password Events beta API to retrieve audit events from your 1Password Business account and send them to your security information and event management (SIEM) system.

The beta API introduces a new audit events endpoint (/api/v3/auditevents) that uses the HTTP GET method and cursor-based pagination with query parameters. This beta endpoint returns structured audit event data beginning December 1, 2025. The data includes information about the actor, the affected entities, and contextual information about the account, where the session originated, and more for each event.

Learn more about the Events API v3 beta.

Requirements​

Before you get started with the beta API, you’ll need to have:

If you already use the Events API with other endpoint versions, you can reuse the same Events Reporting integration and bearer token with the v3 beta endpoint. Make sure your bearer token is scoped for audit events.

Step 1: Set up an Events Reporting integration​

If you haven’t set up Events Reporting yet, create a new integration in your 1Password Business account and issue a bearer token. Save the token in 1Password, then load it into your environment when making API calls.

If you already have Events Reporting set up for your 1Password account, review the integration details to confirm:

  • The integration is active.
  • Your bearer token is active and scoped to access audit events.

Step 2: Find your Events API base URL​

The /api/v3/auditevents beta endpoint currently uses the same Events API servers as the v2 production endpoint.

Choose the base URL that matches the region where your 1Password account is hosted:

If your account is hosted on:Your base URL is:
1password.comhttps://events.1password.com
ent.1password.comhttps://events.ent.1password.com
1password.cahttps://events.1password.ca
1password.euhttps://events.1password.eu

You’ll use this base URL together with the v3 auditevents path. For example:

Step 3: Send a test request with curl​

You can send a test request with curl on the command line to confirm your integration is working.

info

The v3 beta endpoint uses a different HTTP method for requests:

  • v3 beta endpoint: GET /api/v3/auditevents
  • v2 production endpoint: POST /api/v2/auditevents

3.1: Create a curl request​

In your terminal, format your request using the following structure:

Replace the placeholders with your own values:

  • $BASE_URL: The Events API base URL for your 1Password account. For example: https://1password.com.
  • $EVENTS_API_TOKEN: The bearer token for your Events Reporting integration.
  • {events_per_page}: (Optional) The maximum number of events to return in a single response. Use a value from 1 to 1000. If you don’t include the page_size parameter, a default of 100 will be used.
  • {start_time}: (Optional) The date and time for when you want to start retrieving events, in RFC 3339 format . For example: 2026-01-01T00:00:00Z.
  • {end_time}: (Optional) The date and time for when you want to stop retrieving events, in RFC 3339 format . For example: 2026-01-12T23:59:59Z.

If you omit the start_time and end_time parameters, the endpoint will return a page of events using the service-defined default time range.

info

Data collection for the /api/v3/auditevents beta endpoint started December 1, 2025. To access event data prior to that date, you'll need to make a POST request to the /api/v2/auditevents production endpoint.

3.2: Send a curl request​

The following example sends a GET request to the /api/v3/auditevents endpoint, using the curl command structure from the example above. Adjust the query parameters as needed.

See result...

For better readabilty, you can also provide the query parameters on separate lines using --data-urlencode flags.

3.3: Review the response​

Review the response to confirm that the audit_events array contains the expected event data. If the response body is empty, try adjusting your start_time and end_time parameters.

If there are more events available than can be returned in a single response, the beta endpoint returns a meta object that includes:

  • next_page_token: An opaque token you can pass in the next request to retrieve the next page of results.
  • has_more: A boolean value that indicates whether more pages are available (true or false).

For example, the response to the curl request above includes the following meta object:

To request the next page of results, use the next_page_token value as a query parameter. For example:

You can continue calling the endpoint with each next_page_token value that gets returned until has_more is false.

Make sure not to include the start_time or end_time parameters in requests that use a next_page_token. Doing so will result in a 400 bad request error.

To view HTTP status codes and rate limit in the responses, you can use the --include flag in your request. For example:

Step 4: Test the beta endpoint​

After you’ve confirmed your Events API integration is working, you can test the beta /api/v3/auditevents endpoint with your SIEM.

caution

The v3 beta endpoint is stable for testing, but it's possible changes could be made during the beta that will break integrations.

We don't recommend the beta for production use, but we do encourage beta testers to use v3 beta endpoint alongside the v2 production version and provide feedback. You can also use the Events API beta roadmap and changelog to track changes.

Was this page helpful?