--- title: "List Notifications" method: GET path: "/v1/organizations/{organization}/notifications" tags: ["ClientService"] --- # List Notifications `GET /v1/organizations/{organization}/notifications` ## Request - Base URL: `https://api.thirdfort.dev/client/api` - URL: `https://api.thirdfort.dev/client/api/v1/organizations/{organization}/notifications` - Auth: HTTP bearer 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. ## Path parameters - `organization` string, required ## Query parameters - `pageSize` integer - `pageToken` string - `filter` string ## Response `200` A successful response. - ListNotificationsResponse: Response message for [ClientService.ListNotifications](#/operations/ClientService_ListNotifications). - `notifications` Notification[]: The list of notifications matching the request criteria. Notifications are ordered by ID in ascending order (oldest first), making this suitable for cursor-based consumption. - `name` string: The unique resource name of the notification. Format: `organizations/{organization}/notifications/{notification}`. - `type` string: The notification type, which determines the payload shape. Each value below maps to a concrete payload schema in `payload`: | Type | Payload schema | |------|----------------| | `notification.client.check_complete.v1` | [CheckCompleteData](#/schemas/CheckCompleteData) | | `notification.client.report_generated.v1` | [ReportGeneratedData](#/schemas/ReportGeneratedData) | | `notification.client.ongoing_monitoring_hit.v1` | [OngoingMonitoringHitData](#/schemas/OngoingMonitoringHitData) | | `notification.client.ongoing_monitoring_started.v1` | [OngoingMonitoringStartedData](#/schemas/OngoingMonitoringStartedData) | | `notification.client.ongoing_monitoring_renewed.v1` | [OngoingMonitoringRenewedData](#/schemas/OngoingMonitoringRenewedData) | | `notification.client.ongoing_monitoring_renewal_reminder.v1` | [OngoingMonitoringRenewalReminderData](#/schemas/OngoingMonitoringRenewalReminderData) | | `notification.client.additional_document_uploaded.v1` | [AdditionalDocumentUploadedData](#/schemas/AdditionalDocumentUploadedData) | | `notification.client.review_task_assigned.v1` | [ReviewTaskAssignedData](#/schemas/ReviewTaskAssignedData) | | `notification.client.review_completed.v1` | [ReviewCompletedData](#/schemas/ReviewCompletedData) | | `notification.client.review_cancelled.v1` | [ReviewCancelledData](#/schemas/ReviewCancelledData) | | `notification.client.check_secure_shared.v1` | [CheckSecureSharedData](#/schemas/CheckSecureSharedData) | | `notification.client.check_secure_share_revoked.v1` | [CheckSecureShareRevokedData](#/schemas/CheckSecureShareRevokedData) | | `notification.client.check_cancelled.v1` | [CheckCancelledData](#/schemas/CheckCancelledData) | | `notification.client.check_deleted.v1` | [CheckDeletedData](#/schemas/CheckDeletedData) | - `createTime` string, date-time: The time at which the notification was created. - `payload` union - CheckCompleteData: Sent as the payload of `notification.client.check_complete.v1` notifications. [CheckCompleteData](#/schemas/CheckCompleteData) is the payload for `notification.client.check_complete.v1` notifications. This notification is sent when a check has completed all of its processing. - `@type` string: Type URL identifying this message type. Must be `type.googleapis.com/thirdfort.client.notifications.v1.CheckCompleteData`. - `check` string: The resource name of the check that completed. Format: `organizations/{organization}/teams/{team}/checks/{check}` - `displayName` string: The display name of the check at the time of completion. - `state` string: The final state of the check. Possible values: "COMPLETE", "ACTIVE", "CANCELLED", "DELETED". A check that has finished processing reports "COMPLETE" here, even though the corresponding Check resource state is INACTIVE; "INACTIVE" is never sent. - `recommendation` string: The overall recommendation for the check. Possible values: "APPROVE", "CONSIDER", "REJECT", "UNSUPPORTED_BY_PROVIDER", "NOT_APPLICABLE", "UNSPECIFIED". "UNSPECIFIED" is sent when the check completed without a determinate outcome. - ReportGeneratedData: Sent as the payload of `notification.client.report_generated.v1` notifications. [ReportGeneratedData](#/schemas/ReportGeneratedData) is the payload for `notification.client.report_generated.v1` notifications. This notification is sent when a check report has been generated. - `@type` string: Type URL identifying this message type. Must be `type.googleapis.com/thirdfort.client.notifications.v1.ReportGeneratedData`. - `check` string: The resource name of the check whose report was generated. Format: `organizations/{organization}/teams/{team}/checks/{check}` - `displayName` string: The display name of the check. - `reportUrl` string: The URL to download the report. - `summaryReportUrl` string: The URL to download the summary report. - OngoingMonitoringHitData: Sent as the payload of `notification.client.ongoing_monitoring_hit.v1` notifications. [OngoingMonitoringHitData](#/schemas/OngoingMonitoringHitData) is the payload for `notification.client.ongoing_monitoring_hit.v1` notifications. This notification is sent when an ongoing monitoring hit is detected for a check. - `@type` string: Type URL identifying this message type. Must be `type.googleapis.com/thirdfort.client.notifications.v1.OngoingMonitoringHitData`. - `check` string: The resource name of the check that received the hit. Format: `organizations/{organization}/teams/{team}/checks/{check}` - `displayName` string: The display name of the check. - `subjectDisplayName` string: The display name of the monitored subject that received the hit. - `clientReference` string: The client reference for the check. - `newFindingRevisionCount` integer: The number of findings added, updated, or removed by the ongoing monitoring update. Zero when the update changed nothing. - OngoingMonitoringStartedData: Sent as the payload of `notification.client.ongoing_monitoring_started.v1` notifications. [OngoingMonitoringStartedData](#/schemas/OngoingMonitoringStartedData) is the payload for `notification.client.ongoing_monitoring_started.v1` notifications. This notification is sent when ongoing monitoring for a check is started. - `@type` string: Type URL identifying this message type. Must be `type.googleapis.com/thirdfort.client.notifications.v1.OngoingMonitoringStartedData`. - `check` string: The resource name of the check whose monitoring is started. Format: `organizations/{organization}/teams/{team}/checks/{check}` - `displayName` string: The display name of the check. - `activeUntil` string, date-time: The end of the monitoring period, at which it renews automatically unless ongoing monitoring is disabled before then. - OngoingMonitoringRenewedData: Sent as the payload of `notification.client.ongoing_monitoring_renewed.v1` notifications. [OngoingMonitoringRenewedData](#/schemas/OngoingMonitoringRenewedData) is the payload for `notification.client.ongoing_monitoring_renewed.v1` notifications. This notification is sent when ongoing monitoring for a check is renewed. - `@type` string: Type URL identifying this message type. Must be `type.googleapis.com/thirdfort.client.notifications.v1.OngoingMonitoringRenewedData`. - `check` string: The resource name of the check whose monitoring is renewed. Format: `organizations/{organization}/teams/{team}/checks/{check}` - `displayName` string: The display name of the check. - `activeUntil` string, date-time: The end of the new monitoring period, at which it renews again automatically unless ongoing monitoring is disabled before then. - OngoingMonitoringRenewalReminderData: Sent as the payload of `notification.client.ongoing_monitoring_renewal_reminder.v1` notifications. [OngoingMonitoringRenewalReminderData](#/schemas/OngoingMonitoringRenewalReminderData) is the payload for `notification.client.ongoing_monitoring_renewal_reminder.v1` notifications. This notification is sent ahead of the end of an ongoing monitoring billing period as advance notice that the subscription is about to renew itself automatically. No action is needed to keep monitoring running; act on this notification only if the subscription should *not* renew, by disabling ongoing monitoring on the check before `renewal_date`. - `@type` string: Type URL identifying this message type. Must be `type.googleapis.com/thirdfort.client.notifications.v1.OngoingMonitoringRenewalReminderData`. - `check` string: The resource name of the check whose monitoring is due for renewal. Format: `organizations/{organization}/teams/{team}/checks/{check}` - `displayName` string: The display name of the check. - `clientReference` string: The client reference for the check. - `renewalDate` string, date-time: The date the monitoring subscription automatically renews, which is the end of the current billing period. Disable ongoing monitoring before this date to prevent the renewal. - AdditionalDocumentUploadedData: Sent as the payload of `notification.client.additional_document_uploaded.v1` notifications. [AdditionalDocumentUploadedData](#/schemas/AdditionalDocumentUploadedData) is the payload for `notification.client.additional_document_uploaded.v1` notifications. This notification is sent when a consumer uploads an additional document for a check. - `@type` string: Type URL identifying this message type. Must be `type.googleapis.com/thirdfort.client.notifications.v1.AdditionalDocumentUploadedData`. - `check` string: The resource name of the check that the document was uploaded for. Format: `organizations/{organization}/teams/{team}/checks/{check}` - `displayName` string: The display name of the check. - `documentCategory` string: The category of the uploaded document (e.g., "BANK_STATEMENT", "UTILITY_BILL"). - `documentDisplayName` string: The display name of the uploaded document. - `clientReference` string: The client reference for the check. - ReviewTaskAssignedData: Sent as the payload of `notification.client.review_task_assigned.v1` notifications. [ReviewTaskAssignedData](#/schemas/ReviewTaskAssignedData) is the payload for `notification.client.review_task_assigned.v1` notifications. This notification is sent when a review task is created and assigned to a reviewer. - `@type` string: Type URL identifying this message type. Must be `type.googleapis.com/thirdfort.client.notifications.v1.ReviewTaskAssignedData`. - `check` string: The resource name of the check that the review task is for. Format: `organizations/{organization}/teams/{team}/checks/{check}` - `assignee` string: The resource name of the user assigned to review. Format: `organizations/{organization}/users/{user}` - `creator` string: The resource name of the user who requested the review. Format: `organizations/{organization}/users/{user}` - ReviewCompletedData: Sent as the payload of `notification.client.review_completed.v1` notifications. [ReviewCompletedData](#/schemas/ReviewCompletedData) is the payload for `notification.client.review_completed.v1` notifications. This notification is sent when a review has been completed for a check. - `@type` string: Type URL identifying this message type. Must be `type.googleapis.com/thirdfort.client.notifications.v1.ReviewCompletedData`. - `check` string: The resource name of the check that was reviewed. Format: `organizations/{organization}/teams/{team}/checks/{check}` - `assignee` string: The resource name of the user that completed the review. Format: `organizations/{organization}/users/{user}` - `creator` string: The resource name of the user who requested the review. Format: `organizations/{organization}/users/{user}` - `reviewDecision` string: The review decision. - ReviewCancelledData: Sent as the payload of `notification.client.review_cancelled.v1` notifications. [ReviewCancelledData](#/schemas/ReviewCancelledData) is the payload for `notification.client.review_cancelled.v1` notifications. This notification is sent when a review task is cancelled. - `@type` string: Type URL identifying this message type. Must be `type.googleapis.com/thirdfort.client.notifications.v1.ReviewCancelledData`. - `check` string: The resource name of the check that the review task belongs to. Format: `organizations/{organization}/teams/{team}/checks/{check}` - `assignee` string: The resource name of the user assigned to review. Format: `organizations/{organization}/users/{user}` - `cancelledBy` string: The resource name of the user who cancelled the review task. Format: `organizations/{organization}/users/{user}` Empty for system-initiated cancellations — see cancel_reason. - `cancelReason` string: Machine-readable reason for a system-initiated cancellation (e.g. "OM_HIT_RESPAWN" when an ongoing-monitoring update superseded the review task with a fresh one). Empty for user-initiated cancellations, where cancelled_by carries the actor. - CheckSecureSharedData: Sent as the payload of `notification.client.check_secure_shared.v1` notifications. [CheckSecureSharedData](#/schemas/CheckSecureSharedData) is the payload for `notification.client.check_secure_shared.v1` notifications. This notification is sent when a check is secure-shared with a user, so the recipient can be told they now have view-only access. - `@type` string: Type URL identifying this message type. Must be `type.googleapis.com/thirdfort.client.notifications.v1.CheckSecureSharedData`. - `check` string: The resource name of the check that was shared. Format: `organizations/{organization}/teams/{team}/checks/{check}` - `sharedWith` string: The resource name of the user the check was shared with (the recipient). Format: `organizations/{organization}/users/{user}` - CheckSecureShareRevokedData: Sent as the payload of `notification.client.check_secure_share_revoked.v1` notifications. [CheckSecureShareRevokedData](#/schemas/CheckSecureShareRevokedData) is the payload for `notification.client.check_secure_share_revoked.v1` notifications. This notification is sent when a user's secure-share access to a check is revoked by the sharing organisation, so the former recipient can be told they no longer have access. - `@type` string: Type URL identifying this message type. Must be `type.googleapis.com/thirdfort.client.notifications.v1.CheckSecureShareRevokedData`. - `check` string: The resource name of the check the share was revoked from. Format: `organizations/{organization}/teams/{team}/checks/{check}` - `revokedFrom` string: The resource name of the user whose access was revoked (the recipient). Format: `organizations/{organization}/users/{user}` - CheckCancelledData: Sent as the payload of `notification.client.check_cancelled.v1` notifications. [CheckCancelledData](#/schemas/CheckCancelledData) is the payload for `notification.client.check_cancelled.v1` notifications. This notification is sent when a check is cancelled, so a consumer of the API can stop waiting on a check that will never complete. See CDD-7341. - `@type` string: Type URL identifying this message type. Must be `type.googleapis.com/thirdfort.client.notifications.v1.CheckCancelledData`. - `check` string: The resource name of the check that was cancelled. Format: `organizations/{organization}/teams/{team}/checks/{check}` - CheckDeletedData: Sent as the payload of `notification.client.check_deleted.v1` notifications. [CheckDeletedData](#/schemas/CheckDeletedData) is the payload for `notification.client.check_deleted.v1` notifications. This notification is sent when a check is deleted, so a consumer of the API can drop the check from its own records. See CDD-7341. - `@type` string: Type URL identifying this message type. Must be `type.googleapis.com/thirdfort.client.notifications.v1.CheckDeletedData`. - `check` string: The resource name of the check that was deleted. Format: `organizations/{organization}/teams/{team}/checks/{check}` - `nextPageToken` string: 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. ## Other responses - `default`: An unexpected error response. --- [API](https://skmtc.dev/thirdfort/apis/thirdfort-client-api.md) - [All operations](https://skmtc.dev/thirdfort/apis/thirdfort-client-api/llms.txt) - [OpenAPI document](https://skmtc.dev/thirdfort/apis/thirdfort-client-api/revisions/26eb85e05917?raw)