Get a specific notification by ID

GET 
/v1/notifications/:id

Get a specific notification by ID

Request

Path Parameters

id stringrequired

The ID of the notification to retrieve

Responses

200

A notification object

application/json

Schema

Schema

data object

id stringrequired

Unique identifier for the Notification object in string format.

type stringrequired

Default value: notification

Type of object.

attributes object

Notification attributes.

id integerrequired

Unique identifier for the Notification object.

organization_id integerrequired

Unique identifier for the Organization object.

name stringrequired

Unique name for the type of notification.

data objectnullablerequired

Notification data used to capture the extra notification details different for each notification type or name.

created_at date-timerequired

Date and time when the notification was created.

ignored_at date-timenullablerequired

Date and time when the notification was ignored. It is null if the notification is not ignored.

resolved_at date-timenullablerequired

Date and time when the notification was resolved. It is null if the notification is not resolved.

organization_name stringrequired

Name of the organization

type stringrequired

Name of the notification in title case.

state stringrequired

State of the notification. It can be 'Pending', 'Ignored', or 'Resolved'. A notification is in 'Pending' state when it is created. It is in 'Ignored' state when resolved_at is null. It is in 'Resolved' state when resolved_at is not null.

formatted_created_at stringrequired

Formatted created_at date and time in the organization's timezone.

issue_details stringrequired

Issue details in HTML format.

resolve_actions stringrequired

Issue details in HTML format.

links object

self stringrequired

URL to the object or collection of objects.

current stringnullablerequired

URL to the current page of objects. This property is only returned when fetching a collection of objects.

next stringnullablerequired

URL to the next page of notifications. This property is only returned when fetching a collection of objects a next page is available.

last stringnullablerequired

URL to the last page of notifications. This property is only returned when fetching a collection of objects a next page is available.

Example (from schema)

{
  "data": {
    "id": "1",
    "type": "notification",
    "attributes": {
      "id": 1,
      "organization_id": 1,
      "name": "mapping_required",
      "data": {
        "line_item": "gross_sales",
        "jeti_label": "Gross Sales"
      },
      "created_at": "2024-06-06T13:47:41.491Z",
      "ignored_at": "2024-06-06T13:47:41.491Z",
      "resolved_at": "2024-06-06T13:47:41.491Z",
      "organization_name": "string",
      "type": "Mapping Required",
      "state": "Pending",
      "formatted_created_at": "2024-06-06 09:47:41 EDT",
      "issue_details": "<span>Stripe Balance is not mapped</span>",
      "resolve_actions": "<p>Reconnect the connection</p>"
    }
  },
  "links": {
    "self": "https://api.bookkeep.com/v1/notifications",
    "current": "https://api.bookkeep.com/v1/notifications?page[number]=1&page[size]=10",
    "next": "string",
    "last": "string"
  }
}

404

Notification not found or inaccessible

application/json

Schema

Schema

errors object[]
Array [
status stringrequired
source object
pointer stringrequired
title stringrequired
detail stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "status": "404",
      "source": {
        "pointer": "/notifications/0"
      },
      "title": "invalid_or_inaccessible_notification_id",
      "detail": "Notification not found or you do not have access to it. Please try again with a valid notification id or contact support. See '/notifications' for a list of all notifications accessible to you."
    }
  ]
}

Loading...