Fetches a list of notifications
GEThttps://api.bookkeep.com/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
- Example (from schema)
Schema
data object[]
meta object
links object
{
"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"
}
}
Authorization: http
name: basic_authtype: httpdescription: The Bookkeep API uses API keys to authenticate requests. You can view and manage your API keys in the [Bookkeep Developer Dashboard](https://app.bookkeep.com/developers/api_keys). Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed via HTTP Basic Auth. Provide your Publishable key as the basic auth username value and your Secret key as the basic auth password value. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ```curl curl -L -X GET 'https://api.bookkeep.com/v1/entities' \ -H 'Authorization: Basic ZGlsaXAuYmFpcmFnaUBib29ra2VlcC5jbzpXLlM4NVZGbkJyeEY2QmI=' ``` scheme: basic
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X GET 'https://api.bookkeep.com/v1/notifications' \
-H 'Accept: application/json'
ResponseClear