Show/hide List Operations Expand Operations

1. Checklist API

GET /api/organizations/{organization_id}/checklists

Displays checklists

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Filters

Name

Information

circle

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of circles

role

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of roles

member

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of members

meeting

Requirement	[0-9a-f]{24}
Description	Show only checklists created during this meeting

reportTension

Requirement	[0-9a-f]{24}
Description	Show only checklists created during this tension in a meeting

recurrence

Requirement	[a-z_]+(,[a-z_]+)*
Description	A comma separated list of: daily\|weekly\|twice_a_month\|monthly\|bimonthly\|quarterly\|halfyearly\|yearly

global

Description

Displays only global checklists

autocomplete

Description

query

Description

sort

Requirement	([+-](alpha\|circle\|createdAt\|recurrence))
Description

page

Requirement
Description
Default	1

count

Requirement
Description	Between 1 and 100
Default	50

Status Codes

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

Input

Requirements

= -

Filters

= -

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}/checklists

Creates a checklist

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
title	string	true
role	string	false
circle	string	false
global	boolean	true		Only available with privilege: admin
isDraft	boolean	true
template	string	false		Only available when global=true
members[]	array of objects (MemberSelectorType)	false
body	string	false
recurrence	choice	true	["daily","weekly","twice_a_month","monthly","bimonthly","quarterly","halfyearly","yearly"]
checkNow	string	false		Circle
uncheck	string	false		Circle
reportMeeting	string	false
reportTension	string	false

Status Codes

Status Code	Description
201	Checklist 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}/checklists/{checklist_id}

Deletes a checklist

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
checklist_id

Parameters

Parameter	Type	Required?	Format	Description
reportMeeting	string	false

Status Codes

Status Code	Description
204	Checklist 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}/checklists/{checklist_id}

Displays a checklist

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
checklist_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

PATCH /api/organizations/{organization_id}/checklists/{checklist_id}

Updates a checklist

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
checklist_id

Parameters

Parameter	Type	Required?	Format	Description
title	string	false
role	string	false
circle	string	false
global	boolean	false		Only available with privilege: admin
isDraft	boolean	false
template	string	false		Only available when global=true
members[]	array of objects (MemberSelectorType)	false
body	string	false
recurrence	choice	false	["daily","weekly","twice_a_month","monthly","bimonthly","quarterly","halfyearly","yearly"]
checkNow	string	false		Circle
uncheck	string	false		Circle
reportMeeting	string	false
reportTension	string	false

Status Codes

Status Code	Description
200	Checklist 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}/checklists/{checklist_id}/comment

Creates a checklist comment

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
checklist_id

Parameters

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

Status Codes

Status Code	Description
201	Checklist 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}/checklists/{checklist_id}/feed

Displays a checklist feed

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
checklist_id

Filters

Name

Information

activityType

Requirement	[a-z]+(,[a-z]+)*
Description	A comma separated list of: action\|assignation\|checklist\|metric\|objective\|policy\|project\|publication\|role\|task\|tension

maxTime

Requirement	[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]{3}[+-][0-9]{2}:[0-9]{2}
Description	2000-01-01T00:00:00.000+00:00 (pager)

count

Description

Status Codes

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

Input

Requirements

= -

Filters

= -

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. Metric API

GET /api/organizations/{organization_id}/metrics

Displays metrics

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Filters

Name

Information

circle

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of circles

role

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of roles

member

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of members

meeting

Requirement	[0-9a-f]{24}
Description	Show only metrics created during this meeting

reportTension

Requirement	[0-9a-f]{24}
Description	Show only metrics created during this tension in a meeting

recurrence

Requirement	[a-z_]+(,[a-z_]+)*
Description	A comma separated list of: daily\|weekly\|twice_a_month\|monthly\|bimonthly\|quarterly\|halfyearly\|yearly

global

Description

Displays only global metrics

autocomplete

Description

query

Description

sort

Requirement	([+-](alpha\|circle\|createdAt\|recurrence))
Description

page

Requirement
Description
Default	1

count

Requirement
Description	Between 1 and 100
Default	50

Status Codes

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

Input

Requirements

= -

Filters

= -

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}/metrics

Adds a metric

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
title	string	true
body	string	false
recurrence	choice	true	["daily","weekly","twice_a_month","monthly","bimonthly","quarterly","halfyearly","yearly"]
role	string	false
circle	string	false
global	boolean	true		Only available with privilege: admin
isDraft	boolean	true
template	string	false		Only available when global=true
members[]	array of objects (MemberSelectorType)	false
checkNow	string	false		Circle
uncheck	string	false		Circle
reportMeeting	string	false
reportTension	string	false

Status Codes

Status Code	Description
201	Metric is created
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)
404	Role 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}/metrics/{metric_id}

Deletes a metric

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
metric_id

Parameters

Parameter	Type	Required?	Format	Description
reportMeeting	string	false

Status Codes

Status Code	Description
204	Metric 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}/metrics/{metric_id}

Displays a metric

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
metric_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

PATCH /api/organizations/{organization_id}/metrics/{metric_id}

Updates a metric

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
metric_id

Parameters

Parameter	Type	Required?	Format	Description
title	string	false
body	string	false
recurrence	choice	false	["daily","weekly","twice_a_month","monthly","bimonthly","quarterly","halfyearly","yearly"]
role	string	false
circle	string	false
global	boolean	false		Only available with privilege: admin
isDraft	boolean	false
template	string	false		Only available when global=true
members[]	array of objects (MemberSelectorType)	false
checkNow	string	false		Circle
uncheck	string	false		Circle
reportMeeting	string	false
reportTension	string	false

Status Codes

Status Code	Description
200	Metric is updated

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}/metrics/{metric_id}/comment

Creates a metric comment

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
metric_id

Parameters

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

Status Codes

Status Code	Description
201	Metric 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}/metrics/{metric_id}/feed

Displays a metric feed

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
metric_id

Filters

Name

Information

activityType

Requirement	[a-z]+(,[a-z]+)*
Description	A comma separated list of: action\|assignation\|checklist\|metric\|objective\|policy\|project\|publication\|role\|task\|tension

maxTime

Requirement	[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]{3}[+-][0-9]{2}:[0-9]{2}
Description	2000-01-01T00:00:00.000+00:00 (pager)

count

Description

Status Codes

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

Input

Requirements

= -

Filters

= -

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. Attachment API

GET /api/organizations/{organization_id}/attachments

Displays attachments

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Filters

Name

Information

circle

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of circles

action

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of actions

objective

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of OKRs

project

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of projects

role

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of roles

member

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of members

metric

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of metrics

checklist

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of checklists

tension

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of tensions

task

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of tasks

isMainLink

Requirement	(true)
Description

sort

Requirement	([+-]alpha\|[+-]circle\|[+-]role)
Description

page

Requirement
Description
Default	1

count

Requirement
Description	Between 1 and 100
Default	50

Status Codes

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

Input

Requirements

= -

Filters

= -

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}/attachments

Upload an attachment

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?
objective	string	true
role	string	true
metric	string	true
checklist	string	true
tension	string	true
task	string	true
file	file	true

Status Codes

Status Code	Description
201	Attachment 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}/attachments/external

Attach an external attachment

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format
objective	string	true
role	string	true
metric	string	true
checklist	string	true
tension	string	true
task	string	true
mimeType	string	true
provider	choice	true	["awss3","dropbox","generic","googledrive","onedrive"]
url	string	true
filename	string	true
isMainLink	boolean	true

Status Codes

Status Code	Description
201	Attachment 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}/attachments/{attachment_id}

Deletes an attachment

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
attachment_id

Status Codes

Status Code	Description
204	Attachment is deleted
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)
404	Attachment 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}/attachments/{attachment_id}

Displays an attachment

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
attachment_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

PATCH /api/organizations/{organization_id}/attachments/{attachment_id}

Edit the attachment

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
attachment_id

Parameters

Parameter	Type	Required?
title	string	false
url	string	false
isMainLink	boolean	false

Status Codes

Status Code	Description
200	Attachment is edited
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

3. Publication API

GET /api/organizations/{organization_id}/publications

Displays publications

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Filters

Name

Information

circle

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of circles

role

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of roles

Status Codes

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

Input

Requirements

= -

Filters

= -

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}/publications

Adds a publication to a role

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?
title	string	false
body	string	false
richBody	string	false
role	string	false
circle	string	false
url	string	true
category	string	false
isDraft	boolean	true

Status Codes

Status Code	Description
201	Publication is created
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)
404	Role 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

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

Duplicate a publication

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?
id	string	true
title	string	true
circle	string	true

Status Codes

Status Code	Description
201	Publication 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}/publications/merge

Revision of publication

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
id	string	true

Status Codes

Status Code	Description
201	Publication revision
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}/publications/revision

Displays publication revions

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Filters

Name

Information

status

Requirement	(current\|archived)
Description

publication

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of publications

circle

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of circles

role

Requirement	[0-9a-f]{24}(,[0-9a-f]{24})*
Description	A comma separated list of roles

Status Codes

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

Input

Requirements

= -

Filters

= -

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}/publications/revision

Revision of publication

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
id	string	true

Status Codes

Status Code	Description
201	Publication revision
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}/publications/revisions/{publication_revision_id}

Displays a publication revision

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
publication_revision_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

DELETE /api/organizations/{organization_id}/publications/{publication_id}

Deletes a publication

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
publication_id

Status Codes

Status Code	Description
204	Publication is deleted
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)
404	Publication 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}/publications/{publication_id}

Displays a publication

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
publication_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

PATCH /api/organizations/{organization_id}/publications/{publication_id}

Updates a publication

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
publication_id

Parameters

Parameter	Type	Required?
title	string	false
body	string	false
richBody	string	false
role	string	false
circle	string	false
url	string	false
category	string	false
isDraft	boolean	false

Status Codes

Status Code	Description
200	Publication 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}/publications/{publication_id}/restore

Restore revision of publication

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
publication_id

Parameters

Parameter	Type	Required?	Format	Description
id	string	true

Status Codes

Status Code	Description
201	Publication revision restored
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}/publications/{publication_id}/revision

Deletes a publication revision

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
publication_id

Status Codes

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

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}/publications/{publication_id}/revision

Updates a publication revision

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
publication_id

Parameters

Parameter	Type	Required?
title	string	false
body	string	false
richBody	string	false
role	string	false
category	string	false
circle	string	false
members[]	array of objects (MemberSelectorType)	false
participants[]	array of objects (MemberSelectorType)	false

Status Codes

Status Code	Description
200	Publication revision 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. Policy API

GET /api/organizations/{organization_id}/policies

Displays policies

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Filters

Name

Information

circle

Description

role

Description

domain

Description

page

Requirement
Description
Default	1

count

Requirement
Description	Between 1 and 100
Default	50

Status Codes

Status Code	Description
200	Policies list
400	Validation violations
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Filters

= -

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}/policies

Creates a policy

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?
title	string	true
body	string	false
domain	string	false
circle	string	false

Status Codes

Status Code	Description
201	Policy 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}/policies/{policy_id}

Deletes a publication

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
policy_id

Status Codes

Status Code	Description
204	Publication 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}/policies/{policy_id}

Displays a policy

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
policy_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

PUT /api/organizations/{organization_id}/policies/{policy_id}

Updates a policy

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
policy_id

Parameters

Parameter	Type	Required?
title	string	true
body	string	false
domain	string	false
circle	string	false

Status Codes

Status Code	Description
200	Publication is updated

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Holaspirit API documentation

1. Checklist API

GET /api/organizations/{organization_id}/checklists

Requirements

Filters

Status Codes

Requirements

Filters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/organizations/{organization_id}/checklists

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}/checklists/{checklist_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}/checklists/{checklist_id}

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/organizations/{organization_id}/checklists/{checklist_id}

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}/checklists/{checklist_id}/comment

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}/checklists/{checklist_id}/feed

Requirements

Filters

Status Codes

Requirements

Filters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

2. Metric API

GET /api/organizations/{organization_id}/metrics

Requirements