Back to top

Notifications

Notification Management

Retrieve all notifications
GET
/notifications

Returns a collection of the current user’s notification.

  • Parameters
  • all
    boolean in query

    Whether to include read notification in the listing (default false)

    since
    string in query

    Only include notifications updated since the given datetime. Must be a UTC datetime in ISO8601 format. (default Time.now)

    include
    string in query

    related attributes to include

    page
    integer in query

    page to display, default to 1, max 100_000

    per_page
    integer in query

    items per page, default to 10, max 1_000

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"notifications": [
    		{
    			"id": "string",
    			"type": "string",
    			"body": "string",
    			"severity": "string",
    			"read": "boolean",
    			"context": "string",
    			"created_at": "string",
    			"updated_at": "string",
    			"user": {
    				"href": "string"
    			},
    			"href": "string"
    		}
    	],
    	"meta": {
    		"first": {
    			"href": "string"
    		},
    		"previous": {
    			"href": "string"
    		},
    		"self": {
    			"href": "string"
    		},
    		"next": {
    			"href": "string"
    		},
    		"last": {
    			"href": "string"
    		},
    		"total": "integer"
    	}
    }
  • Response  401   unauthorized
Retrieve a notification
GET
/notifications/{id}

Returns a single notification if the user has access

  • Parameters
  • id
    string  (required) in path

    Notification UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"id": "string",
    	"type": "string",
    	"body": "string",
    	"severity": "string",
    	"read": "boolean",
    	"context": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"user": {
    		"href": "string"
    	},
    	"href": "string"
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Update the notification
PUT
/notifications/{id}

Updates a single notification. Currently, the only supported operating is marking a notification as read.

  • Parameters
  • id
    string  (required) in path

    Notification UUID

  • Response  200   ok
  • {
    	"id": "string",
    	"type": "string",
    	"body": "string",
    	"severity": "string",
    	"read": "boolean",
    	"context": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"user": {
    		"href": "string"
    	},
    	"href": "string"
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity