notifications - Documentation

# notifications

### Methods

#### (async, route) list(:id)

##### Route:

Method | Path
--- | ---
POST | /api/bucket/:id/data/notifications

Retrieve notifications about a bucket

##### Authentication

A authentication is needed to access this endpoint

##### Body Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
type | String | optional | Type of notification
before | String | optional | we search logs before this date (lower than)
after | String | optional | we search logs after this date (greater than)
size | Number | optional |
from | Number | optional |
type | String | optional | type of notification
providers | Array | optional | find notifications with this providers
contacts | Array | optional | find notifications with this contact
size | Integer | optional | line limit, default to 20
from | Integer | optional | offset limit

##### Header Parameters:

Name | Type | Description
--- | --- | ---
Authorization | String | bearer access token issued for the user

##### Route Parameters:

Name | Type | Description
--- | --- | ---
:id | String | bucket id

##### Response Code:

Type | Description
--- | ---
500 | database error
200 | succesfully retrieved data

##### Parameters:

Name | Type | Description
--- | --- | ---
`:id` |  | bucket id

#### (async, route) retrieve(:id, :notification)

##### Route:

Method | Path
--- | ---
GET | /api/bucket/:id/data/notifications/:notification

Retrieve specific notification about a bucket

##### Authentication

A authentication is needed to access this endpoint

##### Header Parameters:

Name | Type | Description
--- | --- | ---
Authorization | String | bearer access token issued for the user

##### Route Parameters:

Name | Type | Description
--- | --- | ---
:id | String | bucket id
:notification | String | notification id

##### Response Code:

Type | Description
--- | ---
500 | database error
200 | succesfully retrieved data

##### Parameters:

Name | Type | Description
--- | --- | ---
`:id` |  | bucket id
`:notification` |  | notification id