Show/hide List Operations Expand Operations

1. Task API

GET /api/organizations/{organization_id}/node-tasks

Displays tasks

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
autocomplete	string	true
member	string	true		A comma separated list of members
board	string	true		A comma separated list of boards
circle	string	true		A comma separated list of circles
role	string	true		A comma separated list of roles
objective	string	true		A comma separated list of objectives
column	string	true		A comma separated list of columns
meeting	string	true		Show only projects created during this meeting
reportTension	string	true		Show only projects created during this tension in a meeting
label	string	true		A comma separated list of labels
termAfter	datetime	true
termBefore	datetime	true
checked	string	true
hasBoard	string	true
hasParentTask	string	true
holacracyTaskType	choice	true	["action","project"]
parentTaskId	string	true
status[]	array of choices	true	["current","done"]
view	choice	false	["column"]	Adds column serialization in linked
page	integer	false
count	integer	false		Between 1 and 100
sort	string	false		Allowed values: +alpha, -alpha, +archivedAt, -archivedAt, +createdAt, -createdAt, +position, -position, +positionForTermAtNull, -positionForTermAtNull, +termAt, -termAt, +updatedAt, -updatedAt

Status Codes

Status Code	Description
200	Task list
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/tasks

Displays tasks

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
autocomplete	string	true
member	string	true		A comma separated list of members
board	string	true		A comma separated list of boards
circle	string	true		A comma separated list of circles
role	string	true		A comma separated list of roles
objective	string	true		A comma separated list of objectives
column	string	true		A comma separated list of columns
meeting	string	true		Show only projects created during this meeting
reportTension	string	true		Show only projects created during this tension in a meeting
label	string	true		A comma separated list of labels
termAfter	datetime	true
termBefore	datetime	true
checked	string	true
hasBoard	string	true
hasParentTask	string	true
holacracyTaskType	choice	true	["action","project"]
parentTaskId	string	true
status[]	array of choices	true	["current","done"]
view	choice	false	["column"]	Adds column serialization in linked
page	integer	false
count	integer	false		Between 1 and 100
sort	string	false		Allowed values: +alpha, -alpha, +archivedAt, -archivedAt, +createdAt, -createdAt, +position, -position, +positionForTermAtNull, -positionForTermAtNull, +termAt, -termAt, +updatedAt, -updatedAt

Status Codes

Status Code	Description
200	Task list
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/tasks

Creates a Task

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
body	string	false
context	object (ContextType)	true
context[funnels][]	array of objects (ContextFunnelType)	false
context[funnels][][isSync]	boolean	true
context[funnels][][circle]	string	false
context[funnels][][role]	string	false
context[funnels][][members][]	array of objects (MemberSelectorType)	false
isDraft	boolean	true
private	boolean	true
reportMeeting	string	false
reportTension	string	false
status	choice	false	["current","done"]
term	datetime	false	yyyy-MM-dd'T'HH:mm:ss
title	string	true
circle	string	false		Deprecated: use context
role	string	false		Deprecated: use context
members[]	array of objects (MemberSelectorType)	false		Deprecated: use context
position	integer	false
board	string	true
column	string	true
replicate	boolean	false
labels[]	array of objects (LabelSelectorType)	false
parentTask	string	false

Status Codes

Status Code	Description
201	Task is created
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/tasks/archive

Archive the tasks

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
task[]	array of strings	true
reportMeeting	string	false

Status Codes

Status Code	Description
204	Tasks are archived
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/tasks/duplicate

Duplicate a task

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
id	string	true
title	string	true

Status Codes

Status Code	Description
201	Task is duplicate
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/tasks/sort

Sort the tasks on this column

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
column	string	true
sort	choice	true	["-alpha","+alpha","-createdAt","+createdAt","-termAt","+termAt","-updatedAt","+updatedAt"]

Status Codes

Status Code	Description
204	Tasks are sorted
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/organizations/{organization_id}/tasks/{task_id}

Delete a task

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id

Parameters

Parameter	Type	Required?	Format	Description
reportMeeting	string	false

Status Codes

Status Code	Description
204	Task is deleted
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/tasks/{task_id}

Displays a task

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id

Status Codes

Status Code	Description
200	Displays a task
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/organizations/{organization_id}/tasks/{task_id}

Update a task

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id

Parameters

Parameter	Type	Required?	Format	Description
body	string	false
context	object (ContextType)	false
context[funnels][]	array of objects (ContextFunnelType)	false
context[funnels][][isSync]	boolean	true
context[funnels][][circle]	string	false
context[funnels][][role]	string	false
context[funnels][][members][]	array of objects (MemberSelectorType)	false
isDraft	boolean	false
private	boolean	false
reportMeeting	string	false
reportTension	string	false
status	choice	false	["current","done"]
term	datetime	false	yyyy-MM-dd'T'HH:mm:ss
title	string	false
circle	string	false		Deprecated: use context
role	string	false		Deprecated: use context
members[]	array of objects (MemberSelectorType)	false		Deprecated: use context
id	string	false
checked	boolean	false

Status Codes

Status Code	Description
200	Task is updated
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/tasks/{task_id}/comment

Creates a task comment

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id

Parameters

Parameter	Type	Required?	Format	Description
comment	string	true
step	string	true		For meetings only

Status Codes

Status Code	Description
201	Task comment is created
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/tasks/{task_id}/feed

Displays a task feed

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id

Status Codes

Status Code	Description
200
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/tasks/{task_id}/labels

Attach label to task

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id

Parameters

Parameter	Type	Required?	Format	Description
label	string	true

Status Codes

Status Code	Description
201	Label is attached
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)
404	Project not found

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/organizations/{organization_id}/tasks/{task_id}/labels/{label_id}

Detach label from task

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id
label_id

Status Codes

Status Code	Description
200	Label is detached
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/organizations/{organization_id}/tasks/{task_id}/move

Move a task

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id

Parameters

Parameter	Type	Required?
position	integer	false
board	string	false
column	string	false

Status Codes

Status Code	Description
200	Task is moved
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/tasks/{task_id}/okrs

Attach OKR to task

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id

Parameters

Parameter	Type	Required?	Format	Description
objective	string	true

Status Codes

Status Code	Description
201	OKR is saved
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)
404	Task not found

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/organizations/{organization_id}/tasks/{task_id}/okrs/{okr_id}

Detach OKR from task

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id
okr_id

Status Codes

Status Code	Description
200	OKR is detached
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/tasks/{task_id}/progressions

Creates a Progression

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id

Parameters

Parameter	Type	Required?
title	string	false
start	float	true
end	float	true
progression	float	true
suffix	string	true

Status Codes

Status Code	Description
201	Progression is created
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/organizations/{organization_id}/tasks/{task_id}/progressions/{result_id}

Deletes a Progression

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id
result_id

Status Codes

Status Code	Description
204	Task is deleted
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/organizations/{organization_id}/tasks/{task_id}/progressions/{result_id}

Updates a Progression

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id
result_id

Parameters

Parameter	Type	Required?
title	string	false
start	float	false
end	float	false
progression	float	false
suffix	string	false

Status Codes

Status Code	Description
200	Progression is updated
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/tasks/{task_id}/replicate

Replicate a task for each assign members

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id

Parameters

Parameter	Type	Required?	Format	Description
title	string	true

Status Codes

Status Code	Description
201	Task is replicate
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/tasks/{task_id}/set-parent

Set parent task to a task

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id

Status Codes

Status Code	Description
200	Task parent is set
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/tasks/{task_id}/todolists

Displays task project todo lists

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id

Status Codes

Status Code	Description
200	Tasks list
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/tasks/{task_id}/todolists

Creates a todo list

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id

Parameters

Parameter	Type	Required?	Format	Description
name	string	false

Status Codes

Status Code	Description
201	Todo list is created
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/organizations/{organization_id}/tasks/{task_id}/todolists/{todolist_id}

Deletes a todo list

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id
todolist_id

Status Codes

Status Code	Description
204	Todo list is deleted
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/organizations/{organization_id}/tasks/{task_id}/todolists/{todolist_id}

Updates a todo list

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id
todolist_id

Status Codes

Status Code	Description
200	Todo list is updated
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/tasks/{task_id}/todolists/{todolist_id}/items

Creates a todo list item

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id
todolist_id

Parameters

Parameter	Type	Required?
name	string	false
position	string	true
isDraft	boolean	true
checked	boolean	true

Status Codes

Status Code	Description
201	Todo list item is created
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/stats/organizations/{organization_id}/tasks/{task_id}

Displays stats

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
task_id

Status Codes

Status Code	Description
200
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

2. Board API

GET /api/organizations/{organization_id}/boards

Displays boards

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
autocomplete	string	true
member	string	true
administrator	string	true
favorite	string	true
meeting	string	true		Show only boards created during this meeting
reportTension	string	true		Show only boards created during this tension in a meeting
status	choice	true	["current","done"]
circle	string	true
role	string	true
page	integer	false
count	integer	false		Between 1 and 100
sort	string	false		Allowed values: +alpha, -alpha, +title, -title

Status Codes

Status Code	Description
200	Board list
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/boards

Creates a Board

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format
title	string	true
administrators[]	array of objects (MemberSelectorType)	false
completedColumn	string	false
private	boolean	false
context	object (ContextType)	true
context[funnels][]	array of objects (ContextFunnelType)	false
context[funnels][][isSync]	boolean	true
context[funnels][][circle]	string	false
context[funnels][][role]	string	false
context[funnels][][members][]	array of objects (MemberSelectorType)	false
status	choice	true	["current","done"]
allowColumnUpdate	choice	true	["admin","all"]
contextAssigner	choice	true	["admin","all"]
reportMeeting	string	false
reportTension	string	false

Status Codes

Status Code	Description
201	Board is created
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/organizations/{organization_id}/boards/{board_id}

Delete a board

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
board_id

Status Codes

Status Code	Description
204	Board is deleted
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)
404	Board not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/boards/{board_id}

Displays a board

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
board_id

Status Codes

Status Code	Description
200	Displays a board
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/organizations/{organization_id}/boards/{board_id}

Update a board

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
board_id

Parameters

Parameter	Type	Required?	Format
title	string	false
administrators[]	array of objects (MemberSelectorType)	false
completedColumn	string	false
private	boolean	false
context	object (ContextType)	false
context[funnels][]	array of objects (ContextFunnelType)	false
context[funnels][][isSync]	boolean	true
context[funnels][][circle]	string	false
context[funnels][][role]	string	false
context[funnels][][members][]	array of objects (MemberSelectorType)	false
status	choice	false	["current","done"]
allowColumnUpdate	choice	false	["admin","all"]
contextAssigner	choice	false	["admin","all"]
reportMeeting	string	false
reportTension	string	false

Status Codes

Status Code	Description
200	Board is updated
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/boards/{board_id}/duplicate

Duplicate a board

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
board_id

Parameters

Parameter	Type	Required?	Format	Description
title	string	true

Status Codes

Status Code	Description
201	Board is duplicate
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/organizations/{organization_id}/boards/{board_id}/favorite

Untags a board as favorite

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
board_id

Status Codes

Status Code	Description
204	Board is no longer favorite
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)
404	Board not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/boards/{board_id}/favorite

Tags a board as favorite

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
board_id

Status Codes

Status Code	Description
201	Board is now favorite
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)
404	Board not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/boards/{board_id}/feed

Displays a board feed

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
board_id

Status Codes

Status Code	Description
200
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/node-boards

Displays boards

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Board list
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

3. OKR API

GET /api/organizations/{organization_id}/node-okrs

Displays OKRs

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Objectives list
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/okrs

Displays OKRs

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Objectives list
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/okrs

Creates an OKR

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
id	string	true
title	string	true
description	string	false
circle	string	false
role	string	false
parent	string	false
anchor	boolean	true
status	choice	true	["current","done"]
isDraft	boolean	true
timeframe	string	true
confidence	integer	true		0: not healthy, 5: needs attention, 10: healthy
periodStartAt	datetime	true	yyyy-MM-dd'T'HH:mm:ss
tasks[]	array of objects (TaskSelectorType)	true
members[]	array of objects (MemberSelectorType)	false
reportMeeting	string	false
reportTension	string	false
context	object (ContextType)	true
context[funnels][]	array of objects (ContextFunnelType)	false
context[funnels][][isSync]	boolean	true
context[funnels][][circle]	string	false
context[funnels][][role]	string	false
context[funnels][][members][]	array of objects (MemberSelectorType)	false

Status Codes

Status Code	Description
201	Objective is created
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/okrs/duplicate

Duplicate an OKR

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
id	string	true
title	string	true

Status Codes

Status Code	Description
201	Objective is duplicate
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/organizations/{organization_id}/okrs/{okr_id}

Deletes an OKR

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
okr_id

Parameters

Parameter	Type	Required?	Format	Description
reportMeeting	string	false

Status Codes

Status Code	Description
204	Objective is deleted
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/okrs/{okr_id}

Displays an OKR

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
okr_id

Status Codes

Status Code	Description
200	Objective is displayed
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/organizations/{organization_id}/okrs/{okr_id}

Updates an OKR

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
okr_id

Parameters

Parameter	Type	Required?	Format	Description
id	string	false
title	string	false
description	string	false
circle	string	false
role	string	false
parent	string	false
anchor	boolean	false
status	choice	false	["current","done"]
isDraft	boolean	false
timeframe	string	false
confidence	integer	false		0: not healthy, 5: needs attention, 10: healthy
periodStartAt	datetime	false	yyyy-MM-dd'T'HH:mm:ss
tasks[]	array of objects (TaskSelectorType)	false
members[]	array of objects (MemberSelectorType)	false
reportMeeting	string	false
reportTension	string	false
context	object (ContextType)	false
context[funnels][]	array of objects (ContextFunnelType)	false
context[funnels][][isSync]	boolean	true
context[funnels][][circle]	string	false
context[funnels][][role]	string	false
context[funnels][][members][]	array of objects (MemberSelectorType)	false

Status Codes

Status Code	Description
200	Objective is updated
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/okrs/{okr_id}/comment

Creates an OKR comment

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
okr_id

Parameters

Parameter	Type	Required?	Format	Description
comment	string	true
step	string	true		For meetings only

Status Codes

Status Code	Description
201	OKR comment is created
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/okrs/{okr_id}/feed

Displays an OKR feed

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
okr_id

Status Codes

Status Code	Description
200
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/okrs/{okr_id}/results

Creates a Key Result

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
okr_id

Parameters

Parameter	Type	Required?	Description
title	string	false
start	float	true
end	float	true
progression	float	true
confidence	integer	true	0: not healthy, 5: needs attention, 10: healthy
weight	integer	true
position	integer	true
members[]	array of objects (MemberSelectorType)	true

Status Codes

Status Code	Description
201	Key Result is created
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/organizations/{organization_id}/okrs/{okr_id}/results/{result_id}

Deletes a Key Result

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
okr_id
result_id

Status Codes

Status Code	Description
204	Objective is deleted
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/organizations/{organization_id}/okrs/{okr_id}/results/{result_id}

Updates a Key Result

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
okr_id
result_id

Parameters

Parameter	Type	Required?	Description
title	string	false
start	float	false
end	float	false
progression	float	false
confidence	integer	false	0: not healthy, 5: needs attention, 10: healthy
weight	integer	false
position	integer	false
members[]	array of objects (MemberSelectorType)	false

Status Codes

Status Code	Description
200	Key Result is updated
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/timeframes

Displays Timeframes

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
status	choice	true	["current","archived"]
page	integer	false
count	integer	false		Between 1 and 100

Status Codes

Status Code	Description
200	Timeframes list
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/timeframes

Creates a timeframe

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format
name	string	true
repetition	integer	true
startDate	datetime	true	yyyy-MM-dd'T'HH:mm:ss

Status Codes

Status Code	Description
201	Timeframe is created
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/organizations/{organization_id}/timeframes/{timeframe_id}

Deletes a timeframe

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
timeframe_id

Status Codes

Status Code	Description
204	Timeframe is deleted
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/timeframes/{timeframe_id}

Displays an timeframe

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
timeframe_id

Status Codes

Status Code	Description
200	Timeframe is displayed
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/organizations/{organization_id}/timeframes/{timeframe_id}

Updates a timeframe

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
timeframe_id

Parameters

Parameter	Type	Required?	Format	Description
name	string	false
startDate	datetime	false	yyyy-MM-dd'T'HH:mm:ss

Status Codes

Status Code	Description
200	Timeframe is updated
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

4. Label API

GET /api/organizations/{organization_id}/labels

Displays labels

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Description
autocomplete	string	true
board	string	true	A comma separated list of boards
page	integer	false
count	integer	false	Between 1 and 100
sort	string	false	Allowed values: +alpha, -alpha, +board, -board, +createdAt, -createdAt, +updatedAt, -updatedAt

Status Codes

Status Code	Description
200	Labels list
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/labels

Creates a label

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?
name	string	true
labelColor	string	true
board	string	true

Status Codes

Status Code	Description
201	Label is created
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/organizations/{organization_id}/labels/{label_id}

Deletes a label

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
label_id

Status Codes

Status Code	Description
204	Label is deleted
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/labels/{label_id}

Displays a label

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
label_id

Status Codes

Status Code	Description
200	Label is displayed
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/organizations/{organization_id}/labels/{label_id}

Updates a label

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
label_id

Parameters

Parameter	Type	Required?
name	string	false
labelColor	string	false
board	string	false

Status Codes

Status Code	Description
200	Label is updated
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

5. Column API

GET /api/organizations/{organization_id}/columns

Displays column

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Description
board	string	true	A comma separated list of boards
page	integer	false
count	integer	false	Between 1 and 100
sort	string	false	Allowed values: +alpha, -alpha, +createdAt, -createdAt, +updatedAt, -updatedAt, +position, -position

Status Codes

Status Code	Description
200	Columns list
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/columns

Creates a column

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?
name	string	true
color	string	false
position	integer	true
board	string	true

Status Codes

Status Code	Description
201	Column is created
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/organizations/{organization_id}/columns/{column_id}

Deletes a column

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
column_id

Status Codes

Status Code	Description
204	Column is deleted
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/columns/{column_id}

Displays a column

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
column_id

Status Codes

Status Code	Description
200	Column is displayed
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/organizations/{organization_id}/columns/{column_id}

Updates a column

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
column_id

Parameters

Parameter	Type	Required?
name	string	false
color	string	false
position	integer	false

Status Codes

Status Code	Description
200	Column is updated
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Holaspirit API documentation

1. Task API

GET /api/organizations/{organization_id}/node-tasks

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/tasks

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/tasks

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/tasks/archive

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/tasks/duplicate

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/tasks/sort

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/organizations/{organization_id}/tasks/{task_id}

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/tasks/{task_id}