Notifications

Note the API is currently in beta and is disabled by default. Breaking changes may occur as we finalise the functionality.
Contact us if you want to test the API and we'll turn it on for your account.

Overview

Returns the notification counts.

GET https://acme.minutebase.com/api/v1/notifications

Response

{
    "total":3,
    "unread_comments":2,
    "unapproved_meetings":1
}

Comments

Returns a list of un-read comments, note that this is not paginated.

GET https://acme.minutebase.com/api/v1/notifications/comments

Response

[
    {
        "id":"4c7e61b9cf02a30b31000018",
        "contents":"This is a comment on an agenda heading in some minutes",
        "created_at":1283350969,
        "author":
        {
            "id":"4df2b437cf02a319a90009ea",
            "user_id":"4df2b437cf02a319a90009eb",
            "firstname":"Richard",
            "surname":"Livsey",
            "email":"richard@minutebase.com",
            "administrator":true,
            "company":"MinuteBase",
            "department":null,
            "job_title":"Co-Founder",
            "created_at":1307751479
        },
        "meeting_id":"4c7c077ccf02a32811000015",
        "container_id":"4c7e5b88cf02a309ec00002e",
        "container_type":"minute",
        "meeting":
        {
            "id":"4c7c077ccf02a32811000015",
            "title":"A test meeting",
            "slug":"a-test-meeting",
            "start_at":1283194800,
            "project":
            {
                "id":"4c27f50ccf02a36428000004",
                "title":"Another Project",
                "slug":"another-project",
                "description":null,
                "flag":
                {
                    "left":"yellow",
                    "right":"yellow"
                },
                "created_at":1277687052,
                "archived_at":1283352331
            }
        },
        "container":
        {
            "id":"4c7e5b88cf02a309ec00002e",
            "reference":
            [
                1
            ],
            "type":"agenda_item",
            "meeting_id":"4c7c077ccf02a32811000015",
            "title":"API Documentation"
        }
    }
]

Approvals

Returns a list of unapproved meetings, note that this is not paginated.

GET https://acme.minutebase.com/api/v1/notifications/approvals

Response

[
    {
        "requested_by":
        {
            "id":"4df2b437cf02a319a90009ea",
            "user_id":"4df2b437cf02a319a90009eb",
            "firstname":"Richard",
            "surname":"Livsey",
            "email":"richard@minutebase.com",
            "administrator":true,
            "company":"MinuteBase",
            "department":null,
            "job_title":"Co-Founder",
            "created_at":1307751479
        },
        "requested_at":1304100991,
        "meeting":
        {
            "id":"4c7c077ccf02a32811000015",
            "title":"A test meeting",
            "slug":"a-test-meeting",
            "start_at":1283194800,
            "project":
            {
                "id":"4c27f50ccf02a36428000004",
                "title":"Another Project",
                "slug":"another-project",
                "description":null,
                "flag":
                {
                    "left":"yellow",
                    "right":"yellow"
                },
                "created_at":1277687052,
                "archived_at":1283352331
            }
        },
        "message":"Please approve this meeting",
        "approvals":
        [
            {
                "approved_by":
                {
                    "id":"4df2b437cf02a319a90009ea",
                    "user_id":"4df2b437cf02a319a90009eb",
                    "firstname":"Richard",
                    "surname":"Livsey",
                    "email":"richard@minutebase.com",
                    "administrator":true,
                    "company":"MinuteBase",
                    "department":null,
                    "job_title":"Co-Founder",
                    "created_at":1307751479
                },
                "approved_at":1304100991
            }
        ]
    }
]