Notifications

List notifications

Returns notifications for the user's workspaces, with optional filters for status, read state, scope, and time range.

get/notifications

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/notifications
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Query parameters

fieldsstring nullable

Fields to be returned in a comma-separated format may include id, workspace_id, details

Example:id,workspace_id,details
workspace_idinteger nullable

Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.

Example:4
project_idinteger nullable

Project ID of the workspace

Example:4
last_updated_at__gtestring nullable

Filter notifications updated greater than or equal to the given timestamp. Format: ISO 8601 (e.g. '2023-01-01T00:00:00Z')

Example:2023-01-01T00:00:00Z
statusstring nullable

Filter notifications by status

Example:completed
is_readboolean nullable

Filter notifications read status

Example:true
notification_scope'workspace' | 'project' | 'user'

Notifications can be scoped in these types.

Filter notifications by scope

limitinteger

Max number of result to return

Example:10
offsetinteger

Distance from the beginning of the list of results

Example:10
sortstring

Returned results are sorted by the combination of the given fields.

Example:(id:asc)

Response

List of notifications

Changes

No recorded changes to this operation across all 3 revisions of this API.