OBJECT
Mutation

GraphQL Schema definition

type Mutation {
# Arguments
#   id: Auto-incrementing integer unique to business table. 
#   Generated automatically on create
#   title: The name of the company
#   users: An array of users connected to a business
#   teams: An array of teams connected to a business
#   logo_url: The URL to the logo for the company, which is a 500px 
#   by 500px JPG file. Will be a blank string if the user hasn’t uploaded one yet. 
#   Size can be specified
#   objectives: An array of assigned objectives
#   year_start: Which quarter does this company’s financial year 
#   start in? Must be one of “Q1”, “Q2”, “Q3”,”Q4”. Defaults to “Q1”
#   vision: The company’s vision. A string that can contain line 
#   breaks/paragraphs
#   vision_board_urls: An array of URLs to images that will show on 
#   the company’s vision board of specified size
#   assign_users: Uses a comma seperated list of user ids to assign 
#   to a business
#   remove_users: Uses a comma seperated list of user ids to remove 
#   from a business
business(
id: Int,
title: String,
users: [User],
teams: [Team],
logo_url: String,
objectives: [Objective],
year_start: String,
vision: String,
vision_board_urls: [String],
assign_users: String,
remove_users: String
): Business 
# Arguments
#   email: The email address of the user
#   password: The new password for the user
#   password_reset_token: The password_reset_token for updating 
#   passwords
forgot(email: String, password: String, password_reset_token: String): Forgot 
# Arguments
#   id: Auto-incrementing integer unique to key result table. 
#   Generated automatically on create
#   title: The key result
#   objective_id: The ID for the objective that this belongs to
#   progress: The current progress of the Key Result as set by the 
#   User. Must be an integer between 0-100. Defaults to 0
#   major: Is this a major key result
#   private: Is this a public (0) or a private (1) task
#   type: Is this a commit (0) or a stretch (1)
#   confidence: The confidence in the success of the key result
#   tasks: An array of tasks assigned to a key result
#   person: 2 characters of their name
#   objective: The objective that this belongs to
keyresult(
id: Int,
title: String,
objective_id: Int,
progress: Int,
major: Int,
private: Int,
type: Int,
confidence: Int,
tasks: [Task],
person: String,
objective: Objective
): Keyresult 
# Arguments
#   id: Auto-incrementing integer unique to life area table. 
#   Generated automatically on create
#   title: The life area name
#   user_id: The id of the User
#   objectives: An array of assigned objectives
lifearea(id: Int, title: String, user_id: Int, objectives: [Objective]): Lifearea 
# Arguments
#   email: The user’s email address. Must be a valid email address
#   password: [Not documented]
#   mfa: [Not documented]
login(email: String, password: String, mfa: String): User 
# Arguments
#   id: Auto-incrementing integer unique to objective table. 
#   Generated automatically on create
#   title: The objective
#   life_area_id: The objective's life area id
#   cycle: The year and quarter for the objective
#   type: Type of objective. Allowed values: “LIFE” - A life 
#   objective e.g. “get grade 2 at piano”, “TEAM” - An objective assigned to a team, 
#   “BUSINESS” - An objective assigned to a User within a Business. May or may not 
#   be aligned with other businesses, “BUSINESS_TOP” - A top-level objective of a 
#   company
#   user_id: The id of the User who is assigned to this objective. 
#   Must always be set. If type is “TEAM”, “BUSINESS_TOP” or “BUSINESS” then this 
#   can only be set to an id of a user that belongs to the Business set on 
#   business_id
#   business_id: The id of the Business who is assigned to this 
#   objective. If type is “PERSONAL” this is ignored. Otherwise this can only be set 
#   to an id of a business that the User with user_id belongs to
#   team_id: The ID of the team that this objective is assigned to. 
#   If type is “TEAM” then team_id is required
#   confidence: The confidence in the success of the task
#   parent_objective_id: The id of the Objective to which this 
#   objective is aligned with. This can only be set to an ID of an objective with 
#   the same business_id. It cannot be set to an objective that is already a 
#   ‘descendant’ of this objective as that would cause a loop. If type is 
#   “BUSINESS_TOP” then this value will be cleared out / ignored
#   major: Is this a major objective
#   is_locked: Is this objective locked. An objective is ‘locked’ 
#   at a certain point at the start of a quarter. At that point certain editing 
#   functions are restricted. Defaults to FALSE
#   is_hidden: Should this objective be hidden from other people? 
#   Defaults to FALSE
#   is_important: Has the User assigned to this Objective marked 
#   this as important? Shows on UI as star icon. Defaults to FALSE
#   progress: The current progress of the all the child Key Results 
#   as set by the User. Must be an integer between 0-100. Defaults to 0
#   key_results: An array of key results assigned to an objective
#   tasks: An array of tasks assigned to an objective
#   key_result_count: A count of the key results on this objective
#   task_count: A count of the tasks on this objective
objective(
id: Int,
title: String,
life_area_id: Int,
cycle: String,
type: Int,
user_id: Int,
business_id: Int,
team_id: Int,
confidence: Int,
parent_objective_id: Int,
major: Int,
is_locked: Int,
is_hidden: Int,
is_important: Int,
progress: Int,
key_results: [Keyresult],
tasks: [Task],
key_result_count: Int,
task_count: Int
): Objective 
# Arguments
#   id: Auto-incrementing integer unique to task table. Generated 
#   automatically on create
#   title: The Task
#   key_result_id: The id of the Key Result  that the task is 
#   assigned to
#   due_date: Tasks are assigned to weeks. This field marks the 
#   Monday for the week that the task is assigned to. Defaults to the Monday in the 
#   current week
#   occurence: Is this a one off (0), daily (1), weekly (2), 
#   monthly (3), yearly (4)
#   major: Is this a major objective
#   private: Is this a public (0) or a private (1) task
#   type: Is this a commit (0) or a stretch (1)
#   confidence: The confidence in the success of the task
#   business_id: The id of the Business that the task is assigned 
#   to
#   time_estimate: The User indicates here how long they think the 
#   task will take. They use the UI to set this in hours and minutes but it is 
#   passed to the API as seconds. DEFAULTS to 0
#   key_results: An array of key_results assigned to an objective
#   week: The week number in the year
#   person: 2 characters of their name
#   business: The business that this belongs to
#   keyresult: The Key Result that this belongs to
task(
id: Int,
title: String,
key_result_id: Int,
due_date: Int,
occurence: Int,
major: Int,
private: Int,
type: Int,
confidence: Int,
business_id: Int,
time_estimate: Int,
key_results: [Keyresult],
week: Int,
person: String,
business: Business,
keyresult: KeyresultTask
): Task 
# Arguments
#   id: Auto-incrementing integer unique to team table. Generated 
#   automatically on create
#   title: The team name
#   business: The business thiis team belongs to
#   team_leader: The  User who is assigned as the leader of this 
#   team
#   team_members: The  User who is assigned as the leader of this 
#   team
team(
id: Int,
title: String,
business: Business,
team_leader: User,
team_members: [User]
): Team 
# Arguments
#   id: Auto-incrementing integer unique to user table. Generated 
#   automatically on create
#   title: The user’s name
#   first_name: The user’s first name
#   last_name: The user’s last name
#   mfa_enabled: The user’s account requires mfa
#   role: The user’s role
#   email: The user’s email address. Must be a valid email address
#   access_token: The users session specific access token
#   businesses: An array of businesses this user is assigned to
#   objectives: An array of assigned objectives
#   profile_img_url: The URL to the logo for the user’s profile 
#   picture, which is a 500px by 500px JPG file. Will be a blank string if the user 
#   hasn’t uploaded one yet
#   accounts: Returns a list of businesse accounts the user is 
#   connected to
#   teams: Returns a list of teams the user is connected to
#   life_areas: Returns a list of life areas for the user
#   all_tasks: Returns a list of tasks available to a user
user(
id: Int,
title: String,
first_name: String,
last_name: String,
mfa_enabled: Int,
role: String,
email: String,
access_token: String,
businesses: [Business],
objectives: [Objective],
profile_img_url: String,
accounts: [Businessuser],
teams: [Team],
life_areas: [Lifearea],
all_tasks: [Task]
): User 
}
Require by

This element is not required by anyone
Mutation

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
