# Get a list of events

Endpoint: GET /events
Version: 1.0
Security: bearerAuth

## Query parameters:

  - `page` (integer, required)
    Page of results to show
    Example: 1

  - `pageSize` (integer, required)
    Results to return per page
    Example: 100

  - `sort` (string)
    Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change
    Example: "id,name | name:desc"

  - `fields` (string)
    Comma-delimited list of the field(s) to return if only a subset is required
    Example: "id,name"

  - `category` (string)
    Filter by event category
    Example: "xyz | in:x,y | like:xyz"

  - `action` (string)
    Filter by the action in the event
    Example: "xyz | in:x,y | like:xyz"

  - `createdFrom` (string, required)
    Filter by events created after this timestamp
    Example: "yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ"

  - `createdTo` (string, required)
    Filter by events created before this timestamp
    Example: "yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ"

## Response 200 fields (application/json):

  - `id` (integer)
    Event ID
    Example: 1

  - `timestamp` (string, required)
    Timestamp when the event was created

  - `category` (string, required)
    Category of the event
    Example: "authentication"

  - `action` (string, required)
    The action performed by the user
    Example: "user-login-success"

  - `description` (string)
    Textual description of the event
    Example: "User bob.smith has logged in"

  - `username` (string)
    The username associated with the event
    Example: "bob.smith"

  - `ipAddress` (string)
    The IP address associated with the event
    Example: "12.34.56.78"


## Response 400 fields

## Response 401 fields

## Response 403 fields