# All Notification Events

Get all notification events generated for companies monitored in your portfolios, based on the notification rules enabled. The notification events returned will be filtered based upon the supplied search criteria.

Endpoint: GET /monitoring/notificationEvents
Version: 1.10.9
Security: bearerToken

## Query parameters:

  - `searchQuery` (string)
    Return notificationEvents that match the given value

  - `sortBy` (string)
    Sort results by this column. Null values of sort column are listed after non-nulls.
    Enum: "companyName", "countryCode", "eventId", "eventDate"

  - `sortDir` (string)
    The direction that you wish to sort results by.
    Enum: "asc", "desc"

  - `startDate` (string)
    The start date on which results are filtered.

  - `endDate` (string)
    The end date on which results are filtered.

  - `page` (integer)
    Starting page number inGlobal Monitoring is . If all items are displayed on one page this can also be left blank.

  - `pageSize` (integer)
    Number of items to return per Page.

  - `filterByCreatedDate` (boolean)
    Set to  to filter the Notification Events of the "createdDate" field when using  and  parameters. By default this is set to , with the date parameters filtering using the "eventDate" field.
    Enum: false, true

## Response 200 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.
    Example: "23921650-c073-11ea-860f-06bc8182190e"

  - `totalCount` (number)
    The total number of events returned for the given company.
    Example: 36

  - `data` (array)

  - `data.company` (object)

  - `data.company.id` (string)
    The connectId of the company that triggered the . A connectId is the primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network.
    Example: "US-X-US22384484"

  - `data.company.safeNumber` (string)
    The Safe Number (Creditsafe's identifier on all Companies owned in the Creditsafe Universe) of the company that triggered the .
    Example: "US22384484"

  - `data.company.name` (string)
    The name of the company that triggered the .
    Example: "GOOGLE LLC"

  - `data.company.countryCode` (string)
    ISO/Alpha 2 format country code of the company that triggered the .
    Example: "US"

  - `data.company.portfolioId` (number)
    The portfolio Id of the portfolio that contains the company that triggered the .
    Example: 589960

  - `data.company.portfolioName` (string)
    The name of the portfolio that contains the company that triggered the .
    Example: "Default"

  - `data.eventId` (number)
    The unique identifier of the event that triggered the generation of the . This identifier is consistent across all portfolios in the Global Monitoring product.
    Example: 426992366

  - `data.eventDate` (string)
    The date that the event occurred.
    Example: "2019-12-06T08:23:37"

  - `data.newValue` (string,null)
    Some events contain an  and  (e.g. a change in Credit Limit).
    Example: "1600 AMPHITHEATRE PARKWAY, MOUNTAIN VIEW, CA, 94043-1351"

  - `data.oldValue` (string,null)
    Some events contain an  and  (e.g. a change in Credit Limit).
    Example: "1604 AMPHITHEATRE PARKWAY, MOUNTAIN VIEW, CA, 94043-1351"

  - `data.notificationEventId` (number)
    The unique identifier for the . This identifier is tied to a specific  and .
    Example: 51861887

  - `data.notificationId` (number,null)
    The unique identifier for the . This identifier is tied to a specific  and .

  - `data.processedDate` (string,null)
    If the Notification was sent by email, the date will be populated with when the notification was sent.

  - `data.ruleCode` (number)
    The unique identifier for the  that triggered the generation of the .
    Example: 105

  - `data.ruleName` (string)
    The name of the notification event rule that triggered the generation of the .
    Example: "Address"

  - `data.summary` (string,null)
    A short description of the notification event rule that triggered the .
    Example: "Address Change reported"

  - `data.ruleText` (string,null)
    A short description of the notification event rule that triggered the .
    Example: "Address Change reported"

  - `data.localEventCode` (string,null)
    The local code of the .
    Example: "LI2013"

  - `data.isProcessed` (boolean)
    A  or  flag for each event to whether the system has actioned the notification.
    Example: true

  - `paging` (object)
    Paging parameters.

  - `paging.size` (number,null)
    The maximum number of results returned per page.
    Example: 10

  - `paging.prev` (number,null)
    The page number of the previous page, null if there is no previous page available.

  - `paging.next` (number,null)
    The page number of the next page, null if there is no next page available.
    Example: 2

  - `paging.last` (number,null)
    The page number of the last page.
    Example: 3

## Response 400 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected

## Response 401 fields (application/json):

  - `error` (string)

## Response 403 fields (application/json):

  - `message` (string)
    Example: "Access forbidden"

## Response 404 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected