> For the complete documentation index, see [llms.txt](https://partner-docs.covergenius.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://partner-docs.covergenius.com/rentalcover/endpoints/notifications-list.md).

# Notifications/list

**What it does:** Returns pending booking events created directly in RentalCover.com. For example, date changes or cancellations initiated by RentalCover customer support.

{% hint style="info" %}
**For invoicing partners only**&#x20;

If your integration uses webhooks, you don't need to poll this endpoint. Webhooks deliver the same events in real time.
{% endhint %}

```
GET /notifications/list
```

## Example request

{% tabs %}
{% tab title="GET" %}

```shellscript
curl -i -X GET \
  -H "X_API_KEY: your_api_key" \
  https://api-staging.rentalcover.com/notifications/list
```

{% endtab %}

{% tab title="Response" %}

```graphql
[
   {
      "EventId":"evt_71jea4sjl778s24",
      "Sequence":1,
      "CreatedAt":"2018-01-19 10:38:26",
      "Category":"DirectUpdate",
      "EventStatus":"Pending",
      "Reference":"XXXX-XXXX-INS",
      "Type":"Refund",
      "Currency":"AUD",
      "Amount":-13.82,
      "CurrentAttributes":{
         "Status":"PendingUpdate",
         "Currency":"AUD",
         "TotalAmount":102.16,
         "FromDate":"2018-01-31 00:00:00",
         "ToDate":"2018-02-04 00:00:00",
         "InsuranceCoverAmount":100000,
         "DestinationCountry":"AU",
         "PartnerReference":null,
         "Policy":{
            "Code":"FULLPROTECTION1",
            "Type":"FullProtection",
            "Name":"Full Protection"
         },
         "VehicleTypes":{
            "freecancellationcover":false,
            "freetravelinsurance":false,
            "car":true,
            "motorhome":false,
            "campervan":false,
            "4x4":false,
            "minibus":false,
            "lighttruck":false,
            "bus":false
         },
         "Customer":{
            "FirstName":"Test",
            "LastName":"Test",
            "Email":"test@rentalcover.com",
            "Age":"34",
            "Country":"AU"
         }
      },
      "PreviousAttributes":{
         "Status":"Confirmed",
         "Currency":"AUD",
         "TotalAmount":115.98,
         "FromDate":"2018-01-31 00:00:00",
         "ToDate":"2018-02-05 00:00:00",
         "InsuranceCoverAmount":100000,
         "DestinationCountry":"AU",
         "PartnerReference":null,
         "Policy":{
            "Code":"FULLPROTECTION1",
            "Type":"FullProtection",
            "Name":"Full Protection"
         },
         "VehicleTypes":{
            "freecancellationcover":false,
            "freetravelinsurance":false,
            "car":true,
            "motorhome":false,
            "campervan":false,
            "4x4":false,
            "minibus":false,
            "lighttruck":false,
            "bus":false
         },
         "Customer":{
            "FirstName":"Test",
            "LastName":"Test",
            "Email":"test@rentalcover.com",
            "Age":"34",
            "Country":"AU"
         }
      }
   }
][
   {
      "EventId":"evt_71jea4sjl778s24",
      "Sequence":1,
      "CreatedAt":"2018-01-19 10:38:26",
      "Category":"DirectUpdate",
      "EventStatus":"Pending",
      "Reference":"XXXX-XXXX-INS",
      "Type":"Refund",
      "Currency":"AUD",
      "Amount":-13.82,
      "CurrentAttributes":{
         "Status":"PendingUpdate",
         "Currency":"AUD",
         "TotalAmount":102.16,
         "FromDate":"2018-01-31 00:00:00",
         "ToDate":"2018-02-04 00:00:00",
         "InsuranceCoverAmount":100000,
         "DestinationCountry":"AU",
         "PartnerReference":null,
         "Policy":{
            "Code":"FULLPROTECTION1",
            "Type":"FullProtection",
            "Name":"Full Protection"
         },
         "VehicleTypes":{
            "freecancellationcover":false,
            "freetravelinsurance":false,
            "car":true,
            "motorhome":false,
            "campervan":false,
            "4x4":false,
            "minibus":false,
            "lighttruck":false,
            "bus":false
         },
         "Customer":{
            "FirstName":"Test",
            "LastName":"Test",
            "Email":"test@rentalcover.com",
            "Age":"34",
            "Country":"AU"
         }
      },
      "PreviousAttributes":{
         "Status":"Confirmed",
         "Currency":"AUD",
         "TotalAmount":115.98,
         "FromDate":"2018-01-31 00:00:00",
         "ToDate":"2018-02-05 00:00:00",
         "InsuranceCoverAmount":100000,
         "DestinationCountry":"AU",
         "PartnerReference":null,
         "Policy":{
            "Code":"FULLPROTECTION1",
            "Type":"FullProtection",
            "Name":"Full Protection"
         },
         "VehicleTypes":{
            "freecancellationcover":false,
            "freetravelinsurance":false,
            "car":true,
            "motorhome":false,
            "campervan":false,
            "4x4":false,
            "minibus":false,
            "lighttruck":false,
            "bus":false
         },
         "Customer":{
            "FirstName":"Test",
            "LastName":"Test",
            "Email":"test@rentalcover.com",
            "Age":"34",
            "Country":"AU"
         }
      }
   }
]
```

{% endtab %}
{% endtabs %}

## Response

Returns an array of event objects. After processing each event, call [Notifications/update](/rentalcover/endpoints/notification-update.md) with the `EventId` to prevent it from reappearing.

### Event metadata

<table data-header-hidden="false" data-header-sticky><thead><tr><th width="179.8988037109375">Field</th><th width="149.623291015625">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>EventId</code></td><td>string</td><td>Unique event identifier. Pass to Notifications/update to acknowledge.</td></tr><tr><td><code>Sequence</code></td><td>integer</td><td>Sequence number for ordering events.</td></tr><tr><td><code>CreatedAt</code></td><td>datetime</td><td>When the event was created.</td></tr><tr><td><code>Category</code></td><td>string</td><td><code>DirectUpdate</code>: the booking was modified or cancelled directly in RentalCover.com.</td></tr><tr><td><code>EventStatus</code></td><td>string</td><td><code>Pending</code> or <code>Processed</code>.</td></tr></tbody></table>

### Financial details

<table data-header-hidden="false" data-header-sticky><thead><tr><th width="180.216796875">Field</th><th width="150.2254638671875">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>Reference</code></td><td>string</td><td>Booking reference.</td></tr><tr><td><code>Type</code></td><td>string</td><td>Financial event type: <code>Refund</code>, <code>Charge</code>, or <code>Cancel</code>.</td></tr><tr><td><code>Currency</code></td><td>string</td><td>Currency of the booking.</td></tr><tr><td><code>Amount</code></td><td>float</td><td>Amount to charge or refund. Negative values indicate a refund.</td></tr></tbody></table>

### Booking state

<table data-header-hidden="false" data-header-sticky><thead><tr><th width="180.39990234375">Field</th><th width="149.904052734375">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>CurrentAttributes</code></td><td>object</td><td>Booking state after the change. Contains: <code>Status</code>, <code>Currency</code>, <code>TotalAmount</code>, <code>FromDate</code>, <code>ToDate</code>, <code>InsuranceCoverAmount</code>, <code>DestinationCountry</code>, <code>PartnerReference</code>, <code>Policy</code>, <code>VehicleTypes</code>, <code>Customer</code>.</td></tr><tr><td><code>PreviousAttributes</code></td><td>object</td><td>Booking state before the change. Same structure as <code>CurrentAttributes</code>.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://partner-docs.covergenius.com/rentalcover/endpoints/notifications-list.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
