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

# Notifications API

Get Notifications for a user and send read status.

## Get Notifications

<mark style="color:blue;">`GET`</mark> `https://2i339xpjwf.execute-api.us-east-1.amazonaws.com/prod`

This lets you request all the notifications for a given user.&#x20;

#### Query Parameters

| Name               | Type   | Description                                                                                                                                                                                                                                                                                                                                 |
| ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| notification\_type | string | This could be eithere 'chat' or 'notification'. These are only two accepted value and defaults to 'notification'.  Since we treat notifications as a interaction between platform and user. Hence we can display the response in chat format or notifications format.                                                                       |
| category           | string | <p>This could either be<br> 'get\_list' (gets you list of all notifications for this user) or <br>'read\_status\_update' lets you update the read status of all notification for this user.(you cannot mark individual notification as read)  or<br>'unread\_count' : lets you get a count of total unread notifications for this user.</p> |
| user\_id           | number | This is the user\_id of the job seeker and not the 'id' value. Every Job Seeker has a 'user\_id' send that id to get all notifications.                                                                                                                                                                                                     |
| api\_key           | string | The API key for the tenant. Not the user token.                                                                                                                                                                                                                                                                                             |
| tenant             | string | The tenant id for authentication.                                                                                                                                                                                                                                                                                                           |

{% tabs %}
{% tab title="200 For Category: "get\_list"
Array of notifications.
Subject: Subject of an email or title of notifications.
Body: body or content of the notification.
action\_url: url that could be triggered globally for notification.
actionurl\_btn: the call to action button on the url.
channel\_type: how it was delivered.
content\_type: category of notification
created\_at: when was this notification cretaed.
read\_status: if the notification is already read or not.
read\_time: when was this read. " %}

```
###respose for 'get_list'

[{
"subject":"New shifts for you Standard Driver",
"body":"There are new shifts available in your account. Please click below to see more and request to work",
"content":"system_message: New shifts for you Standard Driver There are new shifts available in your account. Please click below to see more and request to work",
"action_url":"https://wolfdemo.ondemandstaffing.app/",
"actionurl_btn":"Request to work",
"channel_type":"Email",
"content_type":"new_notification",
"created_at":"2020-02-24 21:01:41 +0000",
"read_status":"read",
"read_time":"2020-02-26 16:28:56 +0000"
},
{...}
]

______
###response for 'unread_count'

{'unread_count': 12}

______
###response for 'read_status_update'

{'status': 'updated'}
```

{% endtab %}

{% tab title="404 Could not find any user or notifications for this user." %}

```
{    "message": "Did not find any notifications"}
```

{% endtab %}
{% endtabs %}