> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.perkss.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.perkss.io/_mcp/server.

# List notification history

GET https://api-gateway.perkss.io/api/v1/notifications/history

Pages through the notifications sent on the company's behalf (lifecycle and loyalty emails today). Every row is a send decision: `sent`, or a `failed:<reason>` / `skipped:<reason>` variant — suppressed sends are visible, not silent. Filters are exact matches (`customerId`, `templateKey`, `channel`, `status`); rendered message content is never exposed. `page` is 1-based; `pageSize` defaults to 20 and is capped at 100.

Reference: https://docs.perkss.io/api-reference/perkss-partner-api/notifications/history

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `page` (string, optional) — 1-based page number. Defaults to 1.
- `pageSize` (string, optional) — Rows per page. Defaults to 20, capped at 100.
- `customerId` (string, optional) — Filter to one customer's send history.
- `templateKey` (string, optional) — Filter by notification kind, e.g. 'lifecycle.birthday' or 'loyalty.reward-unlocked'.
- `channel` (string, optional) — Filter by delivery channel, e.g. 'email'.
- `status` (string, optional) — Filter by send decision: 'sent' or a 'failed:\<reason>' / 'skipped:\<reason>' variant.

## Response

### 200

- `total` (double, required) — Total row count after server-side filtering — drives total-page math.
- `page` (double, required) — 1-based page number that produced `items`.
- `pageSize` (double, required) — Page size honored by the server (may be a clamp of the requested value).
- `items` (list of Notification, required) — The history rows on this page.

## Errors

### 400 Bad Request Error

Invalid query. Code: `VALIDATION.REQUEST_INVALID` (`context.validation` lists the offending params).

- `error` (ErrorBody, required)

### 401 Unauthorized Error

Missing, invalid, expired, or revoked access token. Codes: `AUTH.MISSING_BEARER_TOKEN`, `AUTH.INVALID_TOKEN`, `API_AUTH.TOKEN_REVOKED`. Obtain a fresh token at `POST /api/v1/auth/token`.

- `error` (ErrorBody, required)

### 429 Too Many Requests Error

`RATE_LIMIT.EXCEEDED` — reads 600/min per API key (default). Honour `Retry-After` before retrying.

- `error` (ErrorBody, required)

### 503 Service Unavailable Error

`API_AUTH.DENYLIST_UNAVAILABLE` — transient auth-infrastructure outage; retry after `Retry-After` seconds.

- `error` (ErrorBody, required)

## Types

### Notification

- `id` (string, required)
- `templateKey` (string, required) — The notification kind, e.g. 'lifecycle.birthday' or 'loyalty.reward-unlocked'.
- `channel` (string, required) — Delivery channel, e.g. 'email'.
- `status` (string, required) — Send decision: 'sent', or a 'failed:\<reason>' / 'skipped:\<reason>' variant (e.g. 'skipped:unsubscribed').
- `recipientType` (string, required) — Recipient kind, e.g. 'customer'.
- `recipientId` (string, required) — The recipient's id — a customer id when `recipientType` is 'customer'.
- `createdAt` (string, required) — ISO 8601 timestamp of the send decision.

### ErrorBody

- `code` (string, required) — Machine-readable code, namespaced `<DOMAIN>.<NAME>`. Stable: branch on this, never on `message`.
- `message` (string, required) — Human-readable explanation. Not stable across releases — never branch on it.
- `requestId` (string, required) — Correlation id for this request — quote it when contacting support.
- `httpStatus` (double, required) — The response's HTTP status, mirrored into the body.
- `context` (map from string to any, optional) — Optional structured detail — e.g. `validation` messages on a 400, `failureReason` on a 422 rejected write.

## Examples

**Response**

```json
{
  "total": 42,
  "page": 1,
  "pageSize": 20,
  "items": [
    {
      "id": "8a1d4f7c-2e5b-4c9a-8d3f-6b0e9c2a5d18",
      "templateKey": "lifecycle.birthday",
      "channel": "email",
      "status": "sent",
      "recipientType": "customer",
      "recipientId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "createdAt": "2026-07-01T10:30:00.000Z"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api-gateway.perkss.io/api/v1/notifications/history"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api-gateway.perkss.io/api/v1/notifications/history';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-gateway.perkss.io/api/v1/notifications/history"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api-gateway.perkss.io/api/v1/notifications/history")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-gateway.perkss.io/api/v1/notifications/history")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-gateway.perkss.io/api/v1/notifications/history', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api-gateway.perkss.io/api/v1/notifications/history");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-gateway.perkss.io/api/v1/notifications/history")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```