ClientService

List Notifications

Lists Notifications for the specified organization. The oldest available notifications are returned first. Use a page token or filter by create_time to retrieve newer notifications.

get/v1alpha2/organizations/{organization}/notifications

Request

  • Base URL: https://api.thirdfort.dev/client/api
  • URL: https://api.thirdfort.dev/client/api/v1alpha2/organizations/{organization}/notifications
  • Auth: HTTP bearer

Path parameters

organizationstring required

The organization identifier of the resource path.

Query parameters

pageSizeinteger

Optional. The maximum number of notifications to return per page. If not specified, a default value of 25 will be used. Maximum allowed value is 100; larger values are capped at 100 rather than rejected.

pageTokenstring

Optional. A page token, received from a previous ListNotifications call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListNotifications must match the call that provided the page token.

filterstring

Optional. Filter expression to limit the notifications returned. Filtering by the following fields is supported:

  • type: Filter by notification type (e.g., type = "notification.client.check_complete.v1")
  • create_time: Filter by creation time (e.g., create_time > "2024-01-01T00:00:00Z")

Multiple filters can be combined with AND: type = "notification.client.check_complete.v1" AND create_time > "2024-01-01T00:00:00Z"

Response

A successful response.

nextPageTokenstring

A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent request to retrieve the next page. This token is always populated when there are more results, treating notifications as an infinite stream suitable for cursor-based polling.

Changes

No recorded changes to this operation across all 1 revision of this API.