Skip to content

Object types

Here's what we mean when we use these words in the docs.

Team

A team is a group of team members who own one or more maps. Team accounts must be on a paid plan to access the API.

User

Team member

A team member is a user account who belongs to a team. This gives them additional information and abilities to do with the team's maps. Team member accounts get a tick icon ✅ next to their name to denote their special status. Users can be team members in multiple teams.

End-user

End-users are your users, the people who visit your map and interact with it but who do not have team member privileges.

Map

A map belongs to a team and generally represents the roadmap of a project. It contains lists of tasks.

List

A group of tasks that share a similar work status, for example "completed" or "in progress". Lists can have their own permissions, for example whether users are allowed to add suggestions or comment on tasks in the list.

Role

A list's role determines its status in the list, its sorting behaviour, and its default capabilities. For example, the role "Suggestions" means this list appears at the top of the map, holding tasks that have been suggested but not actioned, and by default it shows a form for end-users to suggest new tasks.

Task

A task is a named unit of work and belongs to one list at any one time. Tasks also have a category and related comments, votes, and subscriptions.

Suggestion

"Suggestion" is just a short-hand name for a task that was created by an end-user. The only way end-users can do this is by using the "Add suggestion" form in a list that allows suggestions.

Category

Tasks can have categories, represented by a label and an emoji, as a visual way of communicating the type of work they represent. These can be things like "Design" or "New feature", and are unique to your team.

Comment

Team members and end users can discuss tasks by adding text comments relating to the task.

Vote

Tasks can accrue votes, one per user, and show the total count of votes as a way of ranking their popularity.

Subscription

Users who vote for a task automatically get subscribed to this task. Users are sent daily email updates when the status changes on any task they are subscribed to — for example, when a comment is added, or if the task moves to a new list.