---
title: "Get notification details"
url: "https://nov18-dev.movespot.fyi/apis/konnect-notification-hub-internal-1/versions/8b50299a-30a6-4936-8940-389ddd0013fa/operations/get-notification-details"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-notification-hub-internal-1/versions/8b50299a-30a6-4936-8940-389ddd0013fa.md

# Get notification details

`GET` `/notifications/inbox/{notificationId}`

Operation ID: `get-notification-details`

Get notification details.

## Path parameters

- `notificationId` (string, required) - ID of the notification.

## Responses

- `200` - View a single notification.
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.2
info:
  title: Konnect Notification Hub
  version: 1.0.1
servers:
  - url: https://global.api.konghq.com/v1
    description: Global Base URL
paths:
  /notifications/inbox/{notificationId}:
    get:
      operationId: get-notification-details
      summary: Get notification details
      description: Get notification details.
      parameters:
        - $ref: "#/components/parameters/notificationId"
      responses:
        "200":
          $ref: "#/components/responses/NotificationResponse"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Notifications
security:
  - personalAccessToken: []
components:
  parameters:
    notificationId:
      name: notificationId
      in: path
      required: true
      description: ID of the notification.
      schema:
        type: string
  responses:
    NotificationResponse:
      description: View a single notification.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Notification"
          examples:
            Notification:
              $ref: "#/components/examples/NotificationResponse"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    Notification:
      description: Properties of a notification.
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        title:
          type: string
        description:
          type: string
        status:
          $ref: "#/components/schemas/NotificationStatus"
        region:
          $ref: "#/components/schemas/NotificationRegion"
        namespace:
          $ref: "#/components/schemas/NotificationNamespace"
        entity_id:
          description: ID of the entity. Use '*' to represent all entities of this type.
          type: string
        details:
          description: Metadata associated with the notification to build actionable links.
          type: object
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      additionalProperties: false
      required:
        - id
        - title
        - description
        - status
        - region
        - namespace
        - entity_id
        - details
        - created_at
        - updated_at
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    NotificationStatus:
      description: Status of the notification.
      type: string
      enum:
        - READ
        - UNREAD
        - ARCHIVED
    NotificationRegion:
      description: Region associated to a notification.
      type: string
      enum:
        - US
        - EU
        - AU
        - ME
        - IN
        - "*"
    NotificationNamespace:
      type: string
      enum:
        - plan-and-usage
        - organization
        - dev-portal
        - cloud-gateways
        - regional-event-namespace
        - gateway-manager
        - advanced-analytics
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
  examples:
    NotificationResponse:
      summary: Notification Response
      value:
        id: 93f8380e-7798-4566-99e3-2edf2b57d290
        title: Unpaid invoice reminder
        description: Reminder for an unpaid invoice.
        status: UNREAD
        region: EU
        namespace: plan-and-usage
        entity_id: invoice-1
        details:
          entity_id: invoice-1
          entity_type: invoice
          regions:
            - EU
        created_at: 2023-01-01T00:00:00.000Z
        updated_at: 2023-01-01T00:00:00.000Z
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
```
