> ## Documentation Index > Fetch the complete documentation index at: https://docs.ctrl-hub.com/llms.txt > Use this file to discover all available pages before exploring further. # List your notifications > Retrieve the notifications in your own inbox, newest first. An inbox is personal: the listing is always scoped to the authenticated user and there is no way to read anyone else's, so no permission gates it. Only notifications delivered to the `inbox` channel are listed. A notification that went out by email alone is not part of your inbox. Archived notifications are excluded by default, which makes a bare request the Inbox view. Send `eq(archived,[true])` for the Done view and `eq(saved,[true])` for the Saved view. Counts for the unread badge and the per-domain categories are returned in `meta.stats`, computed across the whole inbox and deliberately ignoring the filters on this request, so the badge does not change when you switch view. ## OpenAPI ````yaml /api-reference/openapi.yaml get /v3/notifications openapi: 3.1.0 info: contact: email: support@ctrl-hub.com name: Ctrl Hub url: https://www.ctrl-hub.com description: > Ctrl Hub is the all-in-one platform for high-risk industries like utilities, construction, infrastructure, and renewables. We help teams manage everything from risk assessments and HAVS exposure to vehicle and equipment checks, with a guaranteed minimum of 200% ROI. license: name: MIT License url: https://opensource.org/licenses/MIT summary: An API for managing your compliance and risk posture termsOfService: https://www.ctrl-hub.com/terms-conditions title: Ctrl Hub version: 1.0.0 servers: - description: Production url: https://api.ctrl-hub.com - description: Staging url: https://api.ctrl-hub.dev - description: Development url: https://api.ctrl-hub.run security: [] tags: - description: | Actions are follow-ups assigned to users and teams, produced manually or by domain producers such as the data-capture workflow runner. name: Actions - description: | Audit events are the events that are logged by the system. name: Audit Events - description: | View the platform's health and availability. name: Status - description: > User-owned dashboards composed of cards on a fixed-slot bento layout. Cards come from a per-domain registry; the API stores their config as opaque JSON. name: Dashboards - description: > A record of documents the platform generated and handed over, retained as evidence of what was issued. `subject_type` says what kind of records an export covers, and it is what decides how the request is authorised: there is no export permission of its own, so if you can see the records you can export them. name: Exports - description: > Scheduled delivery of a saved query's results, as a CSV attachment or a summary email. Every run is retained with the file it sent, so what a recipient received stays retrievable. A report runs as the person who created it, under their own access. name: Reports - description: | Manage appointments for work to be carried out with your customers name: Customer Appointments - description: | Manage interactions you have with your customers name: Customer Interactions - description: | Manage accounts for your customers name: Customer Accounts and Contacts - description: | Qualifications are the skills and knowledge that an organisation requires. name: Qualifications - description: | Workflows allow you to automate your processes. name: Workflows - description: | Manage documents name: Documents - description: | Manage documents name: Folders - description: | Manage documents name: Document Reviews - description: | Manage feature configurations for an organisation. name: Feature Configurations - description: | Equipment are the physical assets that an organisation manages. name: Equipment - description: | The central cost register: time-versioned rate codes for material, labour, contractor and miscellaneous spend, used to cost work against the job hierarchy. name: Costs - description: > Locations are places an organisation manages, optionally classified by a location type. name: Locations - description: > Bulk loads of locations from an uploaded CSV. An import matches rows on the organisation's own `reference`, so re-importing a corrected file updates what is already there rather than doubling the population, and the import record is the audit trail for the whole load: the bulk write path deliberately emits no per-row events. name: Location Imports - description: | Manage your forms and their schemas name: Forms, Schemas and Categories - description: | Create and view form submissions name: Submissions - description: | View the roles available in the system. name: IAM Roles - description: > IAM role groups can be assigned to principals to manage authorisation centrally. name: IAM Role Groups - description: | Manage service accounts which can access the API programmatically. name: Service Accounts - description: | Manage bridges between organisations. name: Bridges - description: | Manage settings for an organisation. name: Settings - description: | Manage teams within an organisation. name: Teams - description: | Manage job roles within an organisation. name: Job Roles - description: | Manage users and accounts. name: Users - description: | Invite and manage invitations to organisations. name: Invitations - description: > IAM grants are the asignment of roles or permissions to principals to manage resource access. name: IAM Grants - description: | View the permissions available in the system. name: IAM Permissions - description: | SSO providers are the identity providers for an organisation. name: SSO Providers - description: | Whoami returns information about the currently authenticated principal. name: Whoami - description: | Your personal inbox. A notification is the thing you receive: an envelope that carries what happened to one or more channels. Email is one of those channels, the inbox is another, and this is where the ones delivered to your inbox are listed, read, saved and archived. name: Notifications - description: | Manage your images name: Images - description: > AI agent personas that synthesise data into role-specific intelligent briefings. name: Agents - description: | Briefings generated by AI agents, including reasoning traces. name: Briefings - description: > Organisations are the center point for most resources in the platform. Most other endpoints are subresources of an organisation. name: Organisations - description: | Permits managements, integrated with street manager. name: Permits - description: | Projects manage your work and governance. name: Projects - description: > Import templates allow users to save and reuse their CSV importer configuration as named templates. name: Import Templates - description: | Properties are the physical locations. name: Properties - description: | Search across schemes, work orders, and operations. name: Search - description: | Provides the API specification in JSON and YAML formats name: Specifications - description: | Streets are the physical roads. name: Streets - description: | Integration with street manager name: Street Manager - description: | Vehicles are the physical vehicles that an organisation manages. name: Vehicles - description: > Scheme contracts (also known as regions) group schemes allocated from the network to a contractor. name: Scheme Contracts - description: > Scheme shares allow you to share your schemes with other organisations across bridges. name: Scheme Shares - description: | Schemes are large programmes of work name: Schemes - description: > Site attendances record who was on site and when, whether or not they hold an account. There is no daily register resource: a day's register and who is currently on site are both queries over the attendances themselves. name: Site Attendances - description: | Work orders the component parts of a scheme. name: Work Orders - description: | Operations are the work to be carried out within work orders. name: Operations externalDocs: description: More documentation and resources url: https://docs.ctrl-hub.com paths: /v3/notifications: get: tags: - Notifications summary: List your notifications description: > Retrieve the notifications in your own inbox, newest first. An inbox is personal: the listing is always scoped to the authenticated user and there is no way to read anyone else's, so no permission gates it. Only notifications delivered to the `inbox` channel are listed. A notification that went out by email alone is not part of your inbox. Archived notifications are excluded by default, which makes a bare request the Inbox view. Send `eq(archived,[true])` for the Done view and `eq(saved,[true])` for the Saved view. Counts for the unread badge and the per-domain categories are returned in `meta.stats`, computed across the whole inbox and deliberately ignoring the filters on this request, so the badge does not change when you switch view. operationId: ListNotifications parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/notifications_sort' - $ref: '#/components/parameters/notifications_filter' responses: '200': $ref: '#/components/responses/ListNotifications' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorised' '500': $ref: '#/components/responses/InternalServerError' security: - Session: [] - OAuth2: [] - Cookie: [] components: parameters: limit: name: limit in: query description: Limit the number of resources returned by the API required: false schema: type: integer format: int64 minimum: 1 default: 100 offset: name: offset in: query description: Offset the resources returned by the API required: false schema: type: integer format: int64 minimum: 0 default: 0 notifications_sort: name: sort in: query description: >- Sort notifications by `created_at` or `status`, prefixed with `-` for descending. Defaults to `-created_at`, so an unsorted request reads newest-first. required: false style: form explode: false schema: type: string example: '-created_at' notifications_filter: name: filter in: query description: >- Filter notifications. Filterable fields are `id`, `status`, `saved`, `archived`, `organisation`, `reason`, `created_at`, and the `notification_type.domain`, `notification_type.entity` and `notification_type.kind` paths. Ownership is imposed from the session and cannot be filtered. Archived notifications are excluded unless `archived` says otherwise. required: false style: form explode: false schema: type: string example: eq(status,[unread]) responses: ListNotifications: description: A list of notifications. headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: allOf: - type: object required: - data properties: data: title: A list of notifications type: array items: $ref: '#/components/schemas/Notification' - $ref: '#/components/schemas/DocumentMeta' - $ref: '#/components/schemas/JSONAPI' - type: object required: - meta properties: meta: type: object required: - stats properties: stats: type: object required: - unread properties: unread: type: object required: - total - by_domain properties: total: type: integer format: int64 description: > Unread and unarchived, across every organisation the recipient works in. Computed over the whole inbox and deliberately ignoring the filters on this request, so the badge reads the same whichever view produced it. by_domain: type: object additionalProperties: type: integer format: int64 description: > Unread counts keyed by `notification_type.domain`, for the category counts in the sources rail. Only domains with at least one unread notification appear, so an absent key is zero rather than missing. BadRequest: description: > There was an error with the request - this could be due to an invalid body, query parameters, or headers that were sent to the API. headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 98ca4a78-b66f-4234-9719-aaf832ee6669 status: '400' title: A validation error was encountered source: parameter: include meta: resource: wrong_value Unauthorised: description: Authentication failed headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 05fc9c8d-73b9-4697-9337-57f7a567a48f status: '401' title: You are not authorised to access this resource detail: In order to access this resource, you need the 'admin' role. code: AUTH.001 InternalServerError: description: There was a problem handling the request on the server side headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: fe9d9a69-f0a7-4fdc-bb2c-176027f316c5 status: '500' title: Internal Server Error detail: An unexpected error occurred on the server. headers: content-type: description: The content type of the response schema: type: string example: application/vnd.api+json content-length: description: The length of the response body in bytes schema: type: integer format: int32 example: 1234 x-request-id: description: >- An ID that can be provided when reporting bugs to help identify the issue schema: type: string example: 8470f56af4cf25e22be08e72c70dbbdc schemas: Notification: type: object description: A notification in a user's inbox required: - id - type - attributes - meta properties: id: type: string format: uuid description: The unique identifier of the notification. type: type: string const: notifications attributes: $ref: '#/components/schemas/NotificationAttributes' meta: $ref: '#/components/schemas/NotificationMeta' DocumentMeta: type: object description: Document level meta about the resources on the server in list endpoints. required: - meta properties: meta: type: object required: - pagination properties: features: $ref: '#/components/schemas/Features' pagination: $ref: '#/components/schemas/Pagination' JSONAPI: type: object description: JSON API response object required: - jsonapi properties: jsonapi: type: object required: - version properties: version: type: string description: The version of the JSON API specification examples: - '1.0' Error: type: object description: An error response properties: id: description: >- A unique identifier for this particular occurrence of the problem. If you encounter this, please provide us with the error ID and we can investigate it on our side. type: string format: uuid examples: - 05fc9c8d-73b9-4697-9337-57f7a567a48f status: description: >- The status code for the error. This might not match the HTTP status code if there are more that one errors to return with different status codes. type: string examples: - '401' - '500' title: description: A human readable title for the error. type: string examples: - You are not authorised to access this resource detail: description: >- Where there is more detail that we can provide outside of the title, we will provide it here. type: string examples: - In order to access this resource, you need the 'admin' role. code: description: >- A unique code for the error that may help us to diagnose the issue. Not all errors have codes, so this is usually empty. type: string examples: - AUTH.001 source: description: A JSON object containing additional information about the error. type: object properties: pointer: description: >- A JSON Pointer to the value in the request that caused the error. type: string examples: - /data/attributes/email parameter: description: >- A string indicating which query parameter in the request caused the error. type: string examples: - include required: - id - status - title NotificationAttributes: type: object description: Attributes for a notification required: - title - body - status - saved - reason - channels - notification_type properties: title: type: string description: >- A short summary of what happened, rendered when the notification was created. body: type: string description: >- The body of the notification, rendered when the notification was created. link: type: string description: A console-relative path to the resource the notification is about. example: /documents/0197f9e5-6a2b-7c3d-8e4f-5a6b7c8d9e0f status: type: string enum: - unread - read description: Whether the recipient has read the notification. saved: type: boolean description: >- Whether the recipient has kept this notification in their saved view. reason: type: string enum: - assigned - participating - nominated - mentioned description: >- Why this person received the notification. `assigned` means they are an approver or assignee, `participating` that they requested, uploaded or previously downloaded it, `nominated` that they hold a job role that was nominated, and `mentioned` is reserved. channels: type: array description: >- The channels this notification was delivered to. Read-only: it records what happened, and is not something a client can change after the fact. items: type: string enum: - inbox - email organisation_id: type: - string - 'null' format: uuid description: >- The organisation the originating event belongs to, when it belongs to one. An inbox spans every organisation its owner works in, so this is for narrowing the view rather than a boundary on it. notification_type: type: object description: >- What produced the notification. Each domain owns its own notification types. required: - domain - entity - kind properties: domain: type: string example: documents entity: type: string example: document kind: type: string example: approved NotificationMeta: type: object description: Metadata for a notification properties: created_at: type: string format: date-time read_at: type: - string - 'null' format: date-time description: When the recipient first read the notification. archived_at: type: - string - 'null' format: date-time description: >- When the recipient archived the notification. There is no delete; archiving is how an inbox is cleared, and the history is kept. Features: type: object description: Represents feature configurations of the API properties: include: type: object properties: options: type: array items: type: string examples: - related.resource Pagination: type: object description: Represents pagination details for API responses required: - counts - current_page - offsets - requested properties: counts: type: object required: - pages - resources properties: pages: type: integer examples: - 1 resources: type: integer examples: - 1 current_page: type: integer examples: - 1 offsets: type: object required: - next - previous properties: next: type: - integer - 'null' examples: - null previous: type: - integer - 'null' examples: - null requested: type: object required: - limit - offset properties: limit: type: integer examples: - 10 offset: type: integer examples: - 0 securitySchemes: Session: description: | Session token for authentication. in: header name: X-Session-Token type: apiKey OAuth2: description: | OAuth2 token for authentication. flows: clientCredentials: scopes: {} tokenUrl: https://auth.ctrl-hub.com/oauth2/token type: oauth2 Cookie: description: | Cookie token for authentication. in: cookie name: ctrl_hub_session type: apiKey ````