Actions

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.

Attributes

• title - action title
• contents - any additional details
• due_by - timestamp of the day the action is due
• state - one of dismissed, completed, overdue or uncompleted
• completed_at - null or a timestamp for when it was completed
• dismissed_at - null or a timestamp for when it was dismissed
• assignees - array of assignees
• comments - array of comments
• type - always "action"
• reference - array representation of the reference number for the minute
• meeting_id - the ID of the meeting it was assigned in

The assignees have the following attributes

• person - who it's assigned to
• completed_at - timestamp for when they completed the action, or null
• created_at - when they were assigned the action

List Actions

You can list actions for the account, for a meeting or for a workspace.

They are filterable by the following parameters:

• assignee_id - ID of the person the action is assigned to
• state - what state the action is in, can be one of outstanding (default), overdue, completed or dismissed
• order - one of due, dismissed, completed, assigned (default)
• dir - either asc or desc (default)

Account Actions

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

Meeting Actions

GET https://acme.minutebase.com/api/v1/meetings/:meeting_id/actions

Workspace Actions

GET https://acme.minutebase.com/api/v1/workspace/:workspace_id/actions

Response

{
    "current_page":1,
    "per_page":25,
    "total_entries":32,
    "total_pages":2,
    "results":
    [
        {
            "assignees":
            [
                {
                    "completed_at":null,
                    "created_at":1308245894,
                    "person":
                    {
                        "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
                    }
                }
            ],
            "comments": [],
            "completed_at":null,
            "contents":"",
            "dismissed_at":null,
            "due_by":1309129200,
            "id":"4dfa381acf02a375d000011f",
            "meeting_id":"4dfa2dd1cf02a37365000047",
            "reference": [1,3],
            "state":"uncompleted",
            "title":"Write API documentation",
            "type":"action"
        }
    ]
}

Get Action

GET https://acme.minutebase.com/api/v1/actions/:action_id

Response

{
    "assignees":
    [
        {
            "completed_at":1309129200,
            "created_at":1308245894,
            "person":
            {
                "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
            }
        }
    ],
    "comments": [],
    "completed_at":1309129200,
    "contents":"",
    "dismissed_at":null,
    "due_by":1309129200,
    "id":"4dfa381acf02a375d000011f",
    "meeting_id":"4dfa2dd1cf02a37365000047",
    "reference": [1,3],
    "state":"completed",
    "title":"Write API documentation",
    "type":"action"
}

Complete Action

PUT https://acme.minutebase.com/api/v1/actions/:action_id/complete

Input

To mark the action as complete by the current person (owner of the API key), you don't need to send any further input. However, you can mark an action as complete on behalf of someone else (if you're a minute-taker of the workspace, or an administrator) by passing in an assignee_id

{
    "assignee_id":"4df2b437cf02a319a90009ea"
}

Response

{
    "assignees":
    [
        {
            "completed_at":1309129200,
            "created_at":1308245894,
            "person":
            {
                "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
            }
        }
    ],
    "comments": [],
    "completed_at":1309129200,
    "contents":"",
    "dismissed_at":null,
    "due_by":1309129200,
    "id":"4dfa381acf02a375d000011f",
    "meeting_id":"4dfa2dd1cf02a37365000047",
    "reference": [1,3],
    "state":"completed",
    "title":"Write API documentation",
    "type":"action"
}

Un-Complete Action

PUT https://acme.minutebase.com/api/v1/actions/:action_id/uncomplete

Input

To mark the action as un-completed by the current person (owner of the API key), you don't need to send any further input. However, you can mark an action as un-completed on behalf of someone else (if you're a minute-taker of the workspace, or an administrator) by passing in an assignee_id

{
    "assignee_id":"4df2b437cf02a319a90009ea"
}

Response

{
    "assignees":
    [
        {
            "completed_at":null,
            "created_at":1308245894,
            "person":
            {
                "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
            }
        }
    ],
    "comments": [],
    "completed_at":null,
    "contents":"",
    "dismissed_at":null,
    "due_by":1309129200,
    "id":"4dfa381acf02a375d000011f",
    "meeting_id":"4dfa2dd1cf02a37365000047",
    "reference": [1,3],
    "state":"uncompleted",
    "title":"Write API documentation",
    "type":"action"
}

Dismiss Action

PUT https://acme.minutebase.com/api/v1/actions/:action_id/dismiss

Response

204 HTTP status with an empty body

Re-Activate Action

PUT https://acme.minutebase.com/api/v1/actions/:action_id/reactivate

Response

204 HTTP status with an empty body

Update Action

Coming soon, currently the only way to update an action is via the minutes API.