---
updatedAt: 2025-06-04T21:28:23.000Z
agentTools:
  projectIndex: https://developer.simpplr.com/llms.txt
---

# Search for Notifications

Use this API to search for Notifications.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "simpplr-api-gateway",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.ec.simpplr.com/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/notifications": {
      "get": {
        "summary": "Search for Notifications",
        "description": "Use this API to search for Notifications.",
        "operationId": "search-for-notifications",
        "parameters": [
          {
            "name": "since",
            "in": "query",
            "description": "Time Stamp",
            "schema": {
              "type": "string",
              "default": "1608021029402"
            }
          },
          {
            "name": "size",
            "in": "query",
            "description": "Page size",
            "schema": {
              "type": "string",
              "default": "1"
            }
          },
          {
            "name": "include-actioned",
            "in": "query",
            "description": "Should actioned Notifications be included",
            "required": true,
            "schema": {
              "type": "boolean",
              "default": true
            }
          },
          {
            "name": "filter",
            "in": "query",
            "description": "Filter to apply to results",
            "schema": {
              "type": "string",
              "enum": [
                "activity",
                "actionable"
              ]
            }
          },
          {
            "name": "x-user-email",
            "in": "header",
            "description": "User's email to login into Salesforce",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"success\",\n    \"result\": {\n        \"newCounts\": {\n            \"activity\": 0,\n            \"actionable\": 7\n        },\n        \"listOfItems\": [\n            {\n                \"user\": {\n                    \"name\": \"Simpplr Service Account\",\n                    \"id\": \"a115e000000abUEAAY\"\n                },\n                \"url\": \"https://simpplr.pbcpayroll.in/Pages/ESS1903.aspx?hash=IN0mRDbZON8fRsv481qnG9En4arlPDKzIJP8TMLrPKbC79GoH9Gc8Mrm9cyz89CmG1I&notificationId=a0O5e000002SgzLEAS\",\n                \"text\": \"{{fullName}} has submmitted leave request for approval\",\n                \"state\": \"actioned\",\n                \"isSeen\": false,\n                \"isRead\": false,\n                \"isActionable\": true,\n                \"id\": \"a0O5e000002SgzLEAS\",\n                \"createdAt\": \"2021-09-14T16:40:28.000+0530\",\n                \"category\": \"External\",\n                \"actionedBy\": {\n                    \"url\": \"https://ajay-hada-dev-ed--c.visualforce.com/apex/app?u=/people/a115e000002FFncAAG\",\n                    \"name\": \"Arun Cherian\",\n                    \"id\": \"a115e000002FFncAAG\"\n                }\n            },\n            {\n                \"user\": {\n                    \"name\": \"Simpplr Service Account\",\n                    \"id\": \"a115e000000abUEAAY\"\n                },\n                \"url\": \"https://simpplr.pbcpayroll.in/Pages/ESS1903.aspx?hash=IN0mRDbZON8fRsv481qnG9En4arlPDKzIJP8TMLrPKbC79GoH9Gc8Mrm9cyz89CmG1I&notificationId=a0O5e000002SgzGEAS\",\n                \"text\": \"{{fullName}} has submmitted leave request for approval\",\n                \"state\": \"new\",\n                \"stamp\": \"pending\",\n                \"isSeen\": false,\n                \"isRead\": false,\n                \"isActionable\": true,\n                \"id\": \"a0O5e000002SgzGEAS\",\n                \"createdAt\": \"2021-09-14T16:21:21.000+0530\",\n                \"category\": \"External\"\n            },\n            {\n                \"user\": {\n                    \"name\": \"Simpplr Service Account\",\n                    \"id\": \"a115e000000abUEAAY\"\n                },\n                \"url\": \"https://simpplr.pbcpayroll.in/Pages/ESS1903.aspx?hash=IN0mRDbZON8fRsv481qnG9En4arlPDKzIJP8TMLrPKbC79GoH9Gc8Mrm9cyz89CmG1I&notificationId=a0O5e000002SgymEAC\",\n                \"text\": \"{{fullName}} has submmitted leave request for approval\",\n                \"state\": \"new\",\n                \"stamp\": \"pending\",\n                \"isSeen\": false,\n                \"isRead\": false,\n                \"isActionable\": true,\n                \"id\": \"a0O5e000002SgymEAC\",\n                \"createdAt\": \"2021-09-14T13:41:16.000+0530\",\n                \"category\": \"External\"\n            },\n            {\n                \"user\": {\n                    \"name\": \"Simpplr Service Account\",\n                    \"id\": \"a115e000000abUEAAY\"\n                },\n                \"url\": \"https://simpplr.pbcpayroll.in/Pages/ESS1903.aspx?hash=IN0mRDbZON8fRsv481qnG9En4arlPDKzIJP8TMLrPKbC79GoH9Gc8Mrm9cyz89CmG1I&notificationId=a0O5e000002SgyhEAC\",\n                \"text\": \"{{fullName}} has submmitted leave request for approval\",\n                \"state\": \"new\",\n                \"stamp\": \"pending\",\n                \"isSeen\": false,\n                \"isRead\": false,\n                \"isActionable\": true,\n                \"id\": \"a0O5e000002SgyhEAC\",\n                \"createdAt\": \"2021-09-14T13:06:12.000+0530\",\n                \"category\": \"External\"\n            },\n            {\n                \"user\": {\n                    \"name\": \"Simpplr Service Account\",\n                    \"id\": \"a115e000000abUEAAY\"\n                },\n                \"url\": \"https://simpplr.pbcpayroll.in/Pages/ESS1903.aspx?hash=IN0mRDbZON8fRsv481qnG9En4arlPDKzIJP8TMLrPKbC79GoH9Gc8Mrm9cyz89CmG1I&notificationId=a0O5e000002SgycEAC\",\n                \"text\": \"{{fullName}} has submmitted leave request for approval\",\n                \"state\": \"new\",\n                \"stamp\": \"pending\",\n                \"isSeen\": false,\n                \"isRead\": false,\n                \"isActionable\": true,\n                \"id\": \"a0O5e000002SgycEAC\",\n                \"createdAt\": \"2021-09-14T13:05:44.000+0530\",\n                \"category\": \"External\"\n            },\n            {\n                \"user\": {\n                    \"name\": \"Simpplr Service Account\",\n                    \"id\": \"a115e000000abUEAAY\"\n                },\n                \"url\": \"https://simpplr.pbcpayroll.in/Pages/ESS1903.aspx?hash=IN0mRDbZON8fRsv481qnG9En4arlPDKzIJP8TMLrPKbC79GoH9Gc8Mrm9cyz89CmG1I&notificationId=a0O5e000002SgdDEAS\",\n                \"text\": \"{{fullName}} has submmitted leave request for approval\",\n                \"state\": \"new\",\n                \"stamp\": \"pending\",\n                \"isSeen\": false,\n                \"isRead\": false,\n                \"isActionable\": true,\n                \"id\": \"a0O5e000002SgdDEAS\",\n                \"createdAt\": \"2021-09-13T16:23:41.000+0530\",\n                \"category\": \"External\"\n            },\n            {\n                \"user\": {\n                    \"name\": \"Simpplr Service Account\",\n                    \"id\": \"a115e000000abUEAAY\"\n                },\n                \"url\": \"https://simpplr.pbcpayroll.in/Pages/ESS1903.aspx?hash=IN0mRDbZON8fRsv481qnG9En4arlPDKzIJP8TMLrPKbC79GoH9Gc8Mrm9cyz89CmG1I&notificationId=a0O5e000002Sgd8EAC\",\n                \"text\": \"{{fullName}} has submmitted leave request for approval\",\n                \"state\": \"new\",\n                \"stamp\": \"pending\",\n                \"isSeen\": false,\n                \"isRead\": false,\n                \"isActionable\": true,\n                \"id\": \"a0O5e000002Sgd8EAC\",\n                \"createdAt\": \"2021-09-13T16:20:41.000+0530\",\n                \"category\": \"External\"\n            },\n            {\n                \"user\": {\n                    \"name\": \"Simpplr Service Account\",\n                    \"id\": \"a115e000000abUEAAY\"\n                },\n                \"url\": \"https://simpplr.pbcpayroll.in/Pages/ESS1903.aspx?hash=IN0mRDbZON8fRsv481qnG9En4arlPDKzIJP8TMLrPKbC79GoH9Gc8Mrm9cyz89CmG1I&notificationId=a0O5e000002Sgd3EAC\",\n                \"text\": \"{{fullName}} has submmitted leave request for approval\",\n                \"state\": \"new\",\n                \"stamp\": \"pending\",\n                \"isSeen\": false,\n                \"isRead\": false,\n                \"isActionable\": true,\n                \"id\": \"a0O5e000002Sgd3EAC\",\n                \"createdAt\": \"2021-09-13T15:39:02.000+0530\",\n                \"category\": \"External\"\n            },\n            {\n                \"user\": {\n                    \"name\": \"Simpplr Service Account\",\n                    \"id\": \"a115e000000abUEAAY\"\n                },\n                \"url\": \"https://simpplr.pbcpayroll.in/Pages/ESS1903.aspx?hash=IN0mRDbZON8fRsv481qnG9En4arlPDKzIJP8TMLrPKbC79GoH9Gc8Mrm9cyz89CmG1I&notificationId=a0O5e000002SfN9EAK\",\n                \"text\": \"{{fullName}} has submmitted leave request for approval\",\n                \"state\": \"actioned\",\n                \"isSeen\": false,\n                \"isRead\": false,\n                \"isActionable\": true,\n                \"id\": \"a0O5e000002SfN9EAK\",\n                \"createdAt\": \"2021-09-09T14:48:12.000+0530\",\n                \"category\": \"External\",\n                \"actionedBy\": {\n                    \"url\": \"https://ajay-hada-dev-ed--c.visualforce.com/apex/app?u=/people/a115e000002FFncAAG\",\n                    \"name\": \"Arun Cherian\",\n                    \"id\": \"a115e000002FFncAAG\"\n                }\n            },\n            {\n                \"url\": \"https://ajay-hada-dev-ed--c.visualforce.com/apex/NotificationRedirectionServer?redirectPageName=HomeFeedSinglePost&notificationId=a0O5e0000026rOJEAY&origin=ian\",\n                \"text\": \"Download the mobile app to connect with coworkers and stay on top of company news\",\n                \"state\": \"read\",\n                \"isSeen\": false,\n                \"isRead\": true,\n                \"isActionable\": false,\n                \"id\": \"a0O5e0000026rOJEAY\",\n                \"createdAt\": \"2021-08-15T18:29:25.000+0530\",\n                \"category\": \"Mobile_Promotion\"\n            }\n        ]\n    },\n    \"responseTimeStamp\": \"1631691487719\",\n    \"message\": \"\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "success"
                    },
                    "result": {
                      "type": "object",
                      "properties": {
                        "newCounts": {
                          "type": "object",
                          "properties": {
                            "activity": {
                              "type": "integer",
                              "example": 0,
                              "default": 0
                            },
                            "actionable": {
                              "type": "integer",
                              "example": 7,
                              "default": 0
                            }
                          }
                        },
                        "listOfItems": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "user": {
                                "type": "object",
                                "properties": {
                                  "name": {
                                    "type": "string",
                                    "example": "Simpplr Service Account"
                                  },
                                  "id": {
                                    "type": "string",
                                    "example": "a115e000000abUEAAY"
                                  }
                                }
                              },
                              "url": {
                                "type": "string",
                                "example": "https://simpplr.pbcpayroll.in/Pages/ESS1903.aspx?hash=IN0mRDbZON8fRsv481qnG9En4arlPDKzIJP8TMLrPKbC79GoH9Gc8Mrm9cyz89CmG1I&notificationId=a0O5e000002SgzLEAS"
                              },
                              "text": {
                                "type": "string",
                                "example": "{{fullName}} has submmitted leave request for approval"
                              },
                              "state": {
                                "type": "string",
                                "example": "actioned"
                              },
                              "isSeen": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              },
                              "isRead": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              },
                              "isActionable": {
                                "type": "boolean",
                                "example": true,
                                "default": true
                              },
                              "id": {
                                "type": "string",
                                "example": "a0O5e000002SgzLEAS"
                              },
                              "createdAt": {
                                "type": "string",
                                "example": "2021-09-14T16:40:28.000+0530"
                              },
                              "category": {
                                "type": "string",
                                "example": "External"
                              },
                              "actionedBy": {
                                "type": "object",
                                "properties": {
                                  "url": {
                                    "type": "string",
                                    "example": "https://ajay-hada-dev-ed--c.visualforce.com/apex/app?u=/people/a115e000002FFncAAG"
                                  },
                                  "name": {
                                    "type": "string",
                                    "example": "Arun Cherian"
                                  },
                                  "id": {
                                    "type": "string",
                                    "example": "a115e000002FFncAAG"
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    "responseTimeStamp": {
                      "type": "string",
                      "example": "1631691487719"
                    },
                    "message": {
                      "type": "string",
                      "example": ""
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"error\",\n    \"message\": \"SESSION_TIMEOUT\",\n    \"i18nmessage\": \"SESSION_TIMEOUT\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "error"
                    },
                    "message": {
                      "type": "string",
                      "example": "SESSION_TIMEOUT"
                    },
                    "i18nmessage": {
                      "type": "string",
                      "example": "SESSION_TIMEOUT"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```