> For the complete documentation index, see [llms.txt](https://docs.pentaho.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pentaho.com/pdc-api-docs/v1/pdc-api-ref-v1/notifications.md). # Notifications ## Get notifications > Returns a paginated list of notifications for the user ```json {"openapi":"3.0.3","info":{"title":"PDC Public API (v1)","version":"v1"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v1/notifications":{"get":{"summary":"Get notifications","tags":["Notifications"],"description":"Returns a paginated list of notifications for the user","parameters":[{"schema":{"type":"number","minimum":1,"maximum":1000,"default":100},"in":"query","name":"pageSize","required":false,"description":"Number of notifications to return"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"data":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","description":"Notification title"},"text":{"type":"string","description":"Notification text"},"target":{"type":"string","format":"uuid","description":"Target user UUID"},"lang":{"type":"string","description":"Language code (e.g., en)","default":"en"},"origin":{"type":"string","nullable":true,"description":"Origin of the notification","default":null},"readStatus":{"type":"boolean","description":"Read status of the notification","default":false},"_id":{"type":"string","format":"uuid","description":"Notification ID"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"}}},"description":"Array of notifications"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Bad Request","type":"object","properties":{"status":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array"},{"type":"object","additionalProperties":true}]}}}}}},"401":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n \tTo access this endpoint:\n\n 1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n 2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n 3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n ","content":{"application/json":{"schema":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n \tTo access this endpoint:\n\n 1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n 2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n 3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n ","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"503":{"description":"Service Unavailable — Connection Refused","content":{"application/json":{"schema":{"description":"Service Unavailable — Connection Refused","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}}}}}}} ``` ## Create a notification > Creates a new notification ```json {"openapi":"3.0.3","info":{"title":"PDC Public API (v1)","version":"v1"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v1/notifications":{"post":{"summary":"Create a notification","tags":["Notifications"],"description":"Creates a new notification","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","description":"Notification title"},"text":{"type":"string","description":"Notification text"},"target":{"type":"string","format":"uuid","description":"Target user UUID"},"lang":{"type":"string","description":"Language code (e.g., en)","default":"en"},"origin":{"type":"string","nullable":true,"description":"Origin of the notification","default":null},"readStatus":{"type":"boolean","description":"Read status of the notification","default":false}},"required":["title","text","target"]}}},"required":true},"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"}},"required":["status","message"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Bad Request","type":"object","properties":{"status":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array"},{"type":"object","additionalProperties":true}]}}}}}},"401":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n \tTo access this endpoint:\n\n 1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n 2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n 3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n ","content":{"application/json":{"schema":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n \tTo access this endpoint:\n\n 1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n 2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n 3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n ","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"503":{"description":"Service Unavailable — Connection Refused","content":{"application/json":{"schema":{"description":"Service Unavailable — Connection Refused","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.pentaho.com/pdc-api-docs/v1/pdc-api-ref-v1/notifications.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.