# Get a list of Tripwire notifications

Endpoint: GET /tripwire-notifications
Version: 1.2
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"

  - `created` (string, required)
    Filter by the notification created date and time
    Example: "xyz | in:x,y | like:xyz"

  - `eventStartDate` (string)
    Filter by the date and time an event started
    Example: "xyz | in:x,y | like:xyz"

  - `eventEndDate` (string)
    Filter by a single date and time an event ended
    Example: "xyz | in:x,y | like:xyz"

  - `action` (string)
    Filter notifications by action taken
    Example: "EMAIL_CUSTOMER_CONTACTS"

  - `productReference` (string)
    Filter notifications by the product reference of the associated usage product inventory
    Example: "xyz | in:x,y | like:xyz"

  - `usageProductInventoryId` (string)
    Filter notifications by usage product inventory id
    Example: "xyz | in:x,y | like:xyz"

  - `customerId` (string)
    Filter notifications by customer identifier
    Example: "xyz | in:x,y | like:xyz"

  - `siteId` (string)
    Filter notifications by site identifier
    Example: "xyz | in:x,y | like:xyz"

## Response 200 fields (application/json):

  - `id` (integer)
    Notification activity identifier
    Example: 1

  - `created` (string)
    Example: "2022-01-01T00:00:00Z"

  - `whenActionApplied` (string)
    Example: "2022-01-01T00:00:00Z"

  - `planId` (number)
    Tripwire plan identifier

  - `planRuleName` (string)
    Tripwire plan rule description
    Example: "Daily calls exceeding £10.00"

  - `eventStartDate` (string)
    Example: "2022-01-01T00:00:00Z"

  - `eventEndDate` (string)
    Example: "2022-01-01T00:00:00Z"

  - `action` (string)
    Tripwire notification activity to be performed when a Tripwire alert is triggered, i.e. send an email to the client/affected customer, suspend the number, or other custom actions (available by contacting the Elevate support team)
    Enum: "EMAIL_BILLING_CLIENT", "SMS_BILLING_CLIENT", "EMAIL_CUSTOMER_CONTACTS", "SMS_CUSTOMER_CONTACTS", "TEMPORARY_OUT_OF_SERVICE", "OUTBOUND_CALLS_BARRED", "CUSTOM_BC_ACTION", "USAGE_CAP_TRIGGER_ACTION", "NO_BC_ACTION"

  - `totalPrice` (number)
    Total price in major currency (e.g. pounds/dollars/euros)
    Example: 10

  - `totalCallCount` (integer)
    Total call count value
    Example: 15

  - `usageProductInventoryId` (integer)
    Usage product inventory identifier
    Example: 10

  - `productReference` (string)
    Product reference

  - `customerId` (number)
    Customer identifier
    Example: 1234

  - `siteId` (number)
    Site identifier
    Example: 1234


## Response 400 fields

## Response 401 fields

## Response 403 fields