Fetches a list of notifications

GET 
/v1/notifications

Retrieves a paginated list of notifications based on the provided query parameters. Each notification includes details such as the notification type, associated organization, and status.

Request

Query Parameters

page[size] integerrequired
The number of notifications to return per page.
Example: 10
page[number] integerrequired
The page number to retrieve.
Example: 1
sort stringrequired
The sorting order of the notifications. Supported values are created_at, -created_at, id, -id, name, -name, ignored_at, -ignored_at, resolved_at, -resolved_at.
Example: -created_at
fields[notification] stringrequired
Comma-separated list of fields to include in the response.
Example: type,state,created_at
filter[organization_id_eq] stringrequired
Filter notifications by fields.
Example: 1

Responses

200

OK

application/json

Schema

Schema

data object[]
Array [
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.
]
meta object

pagination object

current integerrequired

The index of the current page.

next integernullablerequired

The index of the next page. This property is only included when there is a next page available.

last integernullablerequired

The index of the last page. This property is only included when there is a next page available.

records integerrequired

The total number of objects.

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>"
      }
    }
  ],
  "meta": {
    "pagination": {
      "current": 1,
      "next": 2,
      "last": 5,
      "records": 100
    }
  },
  "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"
  }
}

Loading...