> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sharedgraph.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Read network events

> Read network events. Required scope with bearer authority: `read`.



## OpenAPI

````yaml /openapi.json get /api/events
openapi: 3.1.0
info:
  title: SharedGraph public application API
  version: pilot
  description: >-
    Pilot: breaking changes are possible and announced in the changelog.
    SharedGraph is a common social network used through independently operated
    applications. Supported integration: server-backed confidential OAuth client
    using authorization code with S256 PKCE. Anonymous public reads are a pilot
    convenience: 120 requests/minute per connecting address, with a tighter
    shared 30/minute events+reconcile budget. Signed-in views must preserve
    bearer safety rules and never fall back to anonymous after a refusal. No
    account-management, moderator, operator, registration or debug API is part
    of this reference. Provider browser helpers use account cookies; token
    endpoints use Basic; social private reads and mutations use bearer.
    x-app-generation is an application BFF session signal, not a core response
    header. Error catalog below records the pilot domain and OAuth protocol
    refusals; provider error descriptions are diagnostic text, not a stable
    machine identifier.
servers:
  - url: https://api.sharedgraph.com
    description: Hosted pilot network
security:
  - BearerAuth: []
tags:
  - name: Social
  - name: OAuth
  - name: Discovery
paths:
  /api/events:
    get:
      tags:
        - Social
      summary: Read network events
      description: 'Read network events. Required scope with bearer authority: `read`.'
      operationId: get_api_events
      parameters:
        - name: after
          in: query
          schema:
            type: integer
            minimum: 0
            maximum: 9007199254740991
          description: >-
            Default 0. Stale, missing or out-of-range cursor returns
            reconcileRequired:true; replace the local view using reconcile.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Events'
          headers:
            x-sharedgraph-revision:
              description: >-
                SQL admission revision for protected domain reads; absent on
                many errors and OAuth/mutation responses.
              schema:
                type: string
                pattern: ^[0-9]+$
            x-sharedgraph-incarnation:
              description: >-
                Recovery incarnation; revalidate and retire a session if it
                changes.
              schema:
                type: string
            x-sharedgraph-witness-epoch:
              description: Independent witness epoch at read admission.
              schema:
                type: string
                pattern: ^[0-9]+$
        '400':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '405':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '415':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Retry-After:
              description: Positive integer seconds until the anonymous window resets.
              required: true
              schema:
                type: string
                pattern: ^[1-9][0-9]*$
        '500':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security: []
components:
  schemas:
    Events:
      type: object
      properties:
        cursor:
          type: integer
        events:
          type: array
          items:
            $ref: '#/components/schemas/Event'
        reconcileRequired:
          type: boolean
      required:
        - cursor
        - events
        - reconcileRequired
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          enum:
            - unknown_or_immutable_field
            - invalid_text
            - invalid_json
            - intent_required
            - unsupported_audience
            - invalid_parent
            - revision_required
            - self_relation
            - self_block
            - invalid_report
            - invalid_cursor
            - authentication_required
            - auth_unavailable
            - authority_unavailable
            - capability_required
            - not_owner
            - interaction_unavailable
            - social_authority_required
            - not_found
            - intent_conflict
            - revision_conflict
            - post_deleted
            - post_unavailable
            - parent_unavailable
            - effect_mismatch
            - domain_plan_too_large
            - publishing_paused
            - pilot_rate_limited
            - protected_read_unavailable
            - protected_read_storage_unavailable
            - recovery_unavailable
            - domain_storage_unavailable
            - pilot_storage_unavailable
            - pilot_limits_unavailable
            - trusted_address_unavailable
            - origin_required
            - origin_mismatch
            - restriction_witness_required
            - restriction_witness_unavailable_or_incomplete
            - recovery_state_missing
            - recovery_publication_changed
            - recovery_quarantined
            - lifecycle_revision_conflict
            - witness_prepare_mismatch
            - ambiguous_acceptance_requires_independent_proof
            - witness_acceptance_mismatch
            - witness_finalize_unconfirmed
            - invalid_request
            - invalid_client
            - invalid_grant
            - invalid_scope
            - unsupported_grant_type
            - unsupported_response_type
            - access_denied
            - temporarily_unavailable
            - server_error
            - invalid_token
            - unsupported_token_type
            - invalid_target
            - invalid_signature
            - invalid_redirect_uri
            - invalid_request_uri
            - request_not_supported
            - request_uri_not_supported
            - login_required
            - interaction_required
            - account_selection_required
            - consent_required
        message:
          type: string
        error_description:
          type: string
        error_uri:
          type: string
          format: uri
      required:
        - error
      additionalProperties: false
    Event:
      type: object
      properties:
        id:
          type: integer
        kind:
          type: string
          enum:
            - post_changed
            - relations_changed
            - view_invalidated
            - inbox_changed
        targetId:
          type: string
        revision:
          anyOf:
            - type: integer
            - type: 'null'
      required:
        - id
        - kind
        - targetId
        - revision
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Audited access token bound to the current application, actor and
        immutable grant.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.