Get notifications info

Get notifications info including the number of unread notifications, user status, and DND settings.

Method

GET

URL

https://typetalk.com/api/v7/notifications/status

Scope

my

Response Example

{
    "statuses": [
        {
            "unreads": {
                "myTopicIds": [],
                "otherTopicIds": [],
                "dmTopicIds": []
            },
            "userStatus": {
                "id": 123,
                "accountId": 2500,
                "spaceId": 34,
                "emoji": ":spiral_note_pad:",
                "message": "Meeting",
                "clearAt": "2019-09-06T10:49:00Z",
                "isNotificationDisabled": true,
                "createdAt": "2019-09-02T06:28:02Z",
                "updatedAt": "2019-09-06T10:19:43Z"
            },
            "access": {
                "unopened": 0
            },
            "like": {
                "receive": {
                    "hasUnread": false,
                    "readLikeId": 21072
                }
            },
            "mySpace": {
                "space": {
                    "key": "XXXXXX",
                    "name": "Awesome Tech Inc.",
                    "enabled": true,
                    "imageUrl": "https://apps.nulab.com/spaces/XXXXXX/photo/large"
                },
                "myRole": "ADMIN",
                "isPaymentAdmin": true,
                "invitableRoles": [
                    "ADMIN",
                    "USER",
                    "GUEST"
                ],
                "myPlan": {
                    "plan": {
                        "key": "typetalk.standard10",
                        "name": "Standard 10 Users",
                        "limitNumberOfUsers": 10,
                        "limitNumberOfAllowedAddresses": 10,
                        "limitTotalAttachmentSize": 107374182400
                    },
                    "enabled": true,
                    "trial": null,
                    "numberOfUsers": 4,
                    "numberOfAllowedAddresses": 0,
                    "totalAttachmentSize": 14356,
                    "createdAt": "2016-01-27T09:37:27Z",
                    "updatedAt": "2019-09-02T06:05:56Z"
                }
            }
        }
    ],
    "notificationSettings": {
        "doNotDisturb": {
            "scheduled": {
                "enabled": false,
                "start": "22:00",
                "end": "07:00"
            }
        },
        "favoriteTopicMobile": false
    }
}

All responses are formatted in JSON and include an ETag. If you call an API with an If-None-Match header, the server will return a 304 status code if the data is unchanged. The date and time format is ISO 8601, and the timezone is UTC (eg. 2014-01-09T06:20:08Z).