v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB

Notification rules

List notification rules

Lists all notification rules for the user. It optionally takes two parameters - offset and size.

get/api/{cloudId}/v1/notification-rules

Query parameters

offsetinteger

The offset parameter controls the starting point within the collection of resource results.

sizeinteger

The size parameter controls the maximum number of items that may be returned for a single request.

Response

Returned if the request is successful.

Example response

{
  "values": [
    {
      "id": "4292c912-12ac-4ac0-b195-9484fbb98c5c",
      "name": "Create Alert",
      "actionType": "create-alert",
      "criteria": {
        "type": "match-all"
      },
      "timeRestriction": {
        "type": "weekday-and-time-of-day",
        "restrictions": [
          {
            "startDay": "monday",
            "endDay": "friday",
            "startHour": 13,
            "endHour": 18,
            "startMin": 0,
            "endMin": 0
          }
        ]
      },
      "order": 1,
      "steps": [
        {
          "id": "0hcb717e-c442-4185-8bc1-cc998844f567",
          "sendAfter": 0,
          "contact": {
            "method": "email",
            "to": "test@atlassian.com"
          },
          "enabled": true
        }
      ],
      "repeat": {
        "loopAfter": 1,
        "enabled": true
      },
      "enabled": true
    }
  ],
  "links": {
    "next": "/v1/notification-rules?offset=10&size=5"
  }
}