Skip to content

All Notification Events

Request

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.

Security
bearerToken
Query
searchQuerystring

Return notification events that match the given search value across multiple fields.
The search query will filter results based on the following fields:

  • Company Name - Returns events for companies whose name contains the search value
  • Country Code - Returns events for companies in the specified country (e.g., "GB", "US")
  • Event Date - Returns events that occurred on the specified date (format: YYYY-MM-DD)
  • Event ID - Returns the specific notification event matching the provided ID

Examples:

  • Searching for "creditsafe" will return all notification events where the company name, country code, event date, or event ID contains "creditsafe"
  • Searching for a specific Event ID (e.g., "12345") will return only that notification event
  • Searching for "GB" will return notification events for companies in Great Britain
  • Searching for "2025-11-12" will return notification events that occurred on November 12, 2025
sortBystring

Sort results by this column. Null values of sort column are listed after non-nulls.

Default:"eventId"
Enum:"companyName""countryCode""eventId""eventDate"
sortDirstring

The direction that you wish to sort results by.

Default:"asc"
Enum:"asc""desc"
startDatestring, (date-time)

The start date on which results are filtered.

endDatestring, (date-time)

The end date on which results are filtered.

pageinteger

Starting page number inGlobal Monitoring is 0. If all items are displayed on one page this can also be left blank.

Default:0
pageSizeinteger

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

filterByCreatedDateboolean

Set to true to filter the Notification Events of the "createdDate" field when using startDate and endDate parameters. By default this is set to false, with the date parameters filtering using the "eventDate" field.

Default:false
Enum:falsetrue
curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/monitoring/notificationEvents?searchQuery=string&sortBy=companyName&sortDir=asc&startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z&page=0&pageSize=0&filterByCreatedDate=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
correlationIdstring

A unique ID assigned to this request.

Example:"23921650-c073-11ea-860f-06bc8182190e"
totalCountnumber

The total number of events returned for the given company.

Example:36
dataArray of objects
pagingobject(ConnectMonitoringPaging)

Paging parameters.

Response
{ "correlationId": "23921650-c073-11ea-860f-06bc8182190e", "totalCount": 36, "data": [ {} ], "paging": { "size": 10, "prev": 0, "next": 2, "last": 3 } }