Event Access

List Event Access

get/v1/event-access

Request

  • Base URL: https://api.withone.ai
  • URL: https://api.withone.ai/v1/event-access
  • Auth: one of:
    • Session (a scheme the document does not define)
    • OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: user:secrets:read)

Query parameters

environment'test' | 'live'

Optional, and ignored for a bearer - pinned_environment substitutes the token's own.

Defaulted, unlike its counterpart on the create bodies, because the two are different questions: here the value narrows a listing, and the default narrows it to test, which is visible in the rows that come back. There it decides which environment a new key is minted for, where a silently defaulted value is a wrong key rather than a wrong page.

limitinteger

Items per page. Default 20, hard-capped at 150. limit=0 is treated as 1. Larger values silently clamp.

pageinteger

Page number for pagination (1-indexed). Defaults to 1.

skipinteger

Number of items to skip before the first returned item. Defaults to 0. Most callers should leave this at 0 and rely on page + limit.

Response

Paginated list of event access keys

pageinteger required
pagesinteger required
totalinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.