activities10

app_and_url_tracking_settings2

attendance_schedules3

attendance_shifts1

audit_log_entries1

budgets4

client_invoices1

clients5

errors1

global_todos4

holidays1

ignored_user_matches1

ignored_user_patterns1

insights5

integrations4

invite_links5

invites6

job_site_visits2

job_sites7

job_types1

limits2

locations2

manual_time_requests3

member_limits5

members7

network_locations5

notes3

organizations6

overtime_policies6

projects5

rates1

screenshot_settings2

screenshots4

smart_notification_rules6

smart_notifications1

get/v2/organizations/{organization_id}/insights/smart_notificationsList smart notifications

tasks8

team_invoices1

team_payments2

teams8

time_edit_logs2

time_entries1

time_off_balances2

time_off_policies8

time_off_requests6

timesheets2

tool_classifications3

tool_usages4

tracking_states1

unusual_activities1

users2

webhooks6

smart_notifications

List smart notifications

Returns the smart notification ocurrences for the given organization. By default, the API returns only the occurrences for which the API caller (current user) is a recipient of the notification.

Start and stop dates are required, the remaining parameters are optional.

When using the user_ids or team_ids filter, the API will filter the results based on the users who triggered the notification, not the users who will receive the notification.

get/v2/organizations/{organization_id}/insights/smart_notifications

Request

Base URL
https://api.hubstaff.com
Auth
OAuth 2
Authorization codehttps://account.hubstaff.com/authorizations/new
Token URLhttps://account.hubstaff.com/access_tokens
Scopeshubstaff:read, hubstaff:write
TypeScript
https://skmtc.dev/hubstaff/apis/hubstaff-v2-api/docs/v2/organizations/:organization_id/insights/smart_notifications/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organization_idinteger required

Query parameters

page_start_idinteger

The page start ID.

page_limitinteger

The default page size

user_idsinteger[]

List of user IDs

team_idsinteger[]

List of team IDs

created[start]string date-time required

Start time (ISO 8601)

created[stop]string date-time required

Stop time (ISO 8601, exclusive)

rule_idinteger

ID of the smart notification rule to filter by

includestring[]

Specify related data to side load.

Response

A list of smart notifications ocurrences

Changes

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