Show/hide List Operations Expand Operations

1. User API

GET /api/me

Gets my information

Documentation
Sandbox

Status Codes

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

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/me

Updates my information

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Format
email	string	false
password	string	false
currentPassword	string	false
lang	choice	false	["cs_CZ","de_DE","en_US","es_ES","fr_FR","it_IT","ja_JP","nl_NL","pl_PL","pt_BR","ru_RU"]
currentOrganization	string	false
timezone	choice	false
country	string	false
intercomInteraction	boolean	false
multiFactorAuthentication	object (MultiFactorAuthenticationType)	false
multiFactorAuthentication[enforced]	boolean	true

Status Codes

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

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /oauth/v2/revoke

Deletes an AccessToken

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Format	Description
token	text	false

Status Codes

Status Code	Description
200	User information
400	Missing token, or error during token deletion
401	Unauthorized (i.e. OAuth2 authentication required)

Input

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

2. Member API

GET /api/organizations/{organization_id}/members

Displays organization members

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

privilege

Requirement	[a-z]+(,[a-z]+)*
Description	A comma separated list of: inactive\|member\|admin\|api

activated

Requirement	(true\|false)
Description

assigned

Requirement	(true\|false)
Description

suspended

Requirement	(true\|false)
Description

autocomplete

Description

lastLoginAfter

Description

lastLoginBefore

Description

sort

Requirement	([+-](alpha\|createdAt\|email\|lastName\|rolesCount\|updatedAt))
Description

page

Requirement
Description
Default	1

count

Requirement
Description	Between 1 and 100
Default	50

Status Codes

Status Code	Description
200	List all members
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}/members admin-access

Creates a member to the organization

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format
firstName	string	false
lastName	string	false
email	string	false
phone	string	false
avatar	string	false
privilege	choice	true	["owner","admin","member","inactive","api"]
locations	string	false
skills	string	false
circles[]	array of objects (CircleSelectorType)	false

Status Codes

Status Code	Description
201	Member is created and attached to the organization
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}/members/bulk admin-access

Bulk update members from a list of ids

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format
members[]	array of objects (MemberSelectorType)	true
action	choice	true	["updatePrivilege","updateStatus","sendInvitations"]
value	choice	true	["admin","member","inactive","restore","suspend","delete","send"]

Status Codes

Status Code	Description
201	Members are 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}/members/import admin-access

Creates many members from a list of emails

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format
content	string	true
privilege	choice	true	["owner","admin","member","inactive","api"]
circles[]	array of objects (CircleSelectorType)	false

Status Codes

Status Code	Description
201	Members are created and attached to the organization
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}/members/{member_id} admin-access

Deletes a member

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
member_id

Status Codes

Status Code	Description
204	Member is deleted
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}/members/{member_id}

Displays organization member

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
member_id

Status Codes

Status Code	Description
200	Displays organization member
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}/members/{member_id}

Updates a member

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
member_id

Parameters

Parameter	Type	Required?	Format	Description
firstName	string	false
lastName	string	false
initials	string	false
biography	string	false
phone	string	false
avatar	string	false
email	string	false		Allowed only for inactive members (visitor access).
privilege	choice	false	["owner","admin","member","inactive","api"]
suspended	boolean	false
translationShow	boolean	false
activateNotificationsWhenJoinCircle	boolean	false
translationLanguage	choice	false	["ar","bg","bn","ca","cs","da","de","el","en","es","et","fa","fi","fr","he","hi","hr","hu","id","it","ja","ko","lt","lv","ms","nl","no","pl","pt","ro","ru","sk","sl","sq","sr","sv","ta","th","tl","tr","uk","ur","vi","zh-Hans","zh-Hant"]
locations[]	array of strings	false
skills[]	array of strings	false
experiments	string	false
globalNotifications	string	false
hiddenPromotion	integer	false

Status Codes

Status Code	Description
200	Member 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}/members/{member_id}/feed

Displays a member feed

Documentation
Sandbox

Requirements

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

GET /api/organizations/{organization_id}/members/{member_id}/mention-history

Displays mention history

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
member_id

Filters

Name

Information

types

Description

A comma separated list types member|role|circle

Status Codes

Status Code	Description
200	Displays mention history member
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}/members/{member_id}/mention-history

Creates a mention history

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
member_id

Parameters

Parameter	Type	Required?	Format	Description
id	string	true
type	choice	true	["circle","member","role","publication"]

Status Codes

Status Code	Description
204	Mention history 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}/members/{member_id}/resend-invitation admin-access

Resends an invitation to a member

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
member_id

Status Codes

Status Code	Description
201	Invitation is sent again
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}/members/{member_id}/search-history

Displays search history

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
member_id

Filters

Name

Information

types

Description

taskType

Requirement	(action\|project)
Description

Status Codes

Status Code	Description
200	Displays search history member
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}/members/{member_id}/search-history

Creates a search history

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
member_id

Parameters

Parameter	Type	Required?	Format	Description
id	string	true
type	choice	true	["action","attachment","board","checklist","circle","member","metric","objective","policy","project","publication","role","task","tension"]

Status Codes

Status Code	Description
204	Search history 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}/members/{member_id}/timespent

Displays my time spent

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
member_id

Status Codes

Status Code	Description
200	Displays organization member
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}/members/{member_id}/timespent

Save my time spent

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
member_id

Parameters

Parameter	Type	Required?
fullTimeEquivalent	float	true
times[]	array of objects (TimeSpentRoleType)	true
times[][role]	string	true
times[][timeSpent]	float	true

Status Codes

Status Code	Description
201	Time spent is saved to the organization
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}/members/{member_id}

Displays stats

Documentation
Sandbox

Requirements

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

3. Notifications API

GET /api/organizations/{organization_id}/members/{member_id}/notifications

Displays notifications

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
member_id

Filters

Name

Information

circle

Description

page

Requirement
Description
Default	1

count

Requirement
Description	Between 1 and 100
Default	50

Status Codes

Status Code	Description
200	Notification's 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}/members/{member_id}/notifications

Creates a notification

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
member_id

Parameters

Parameter	Type	Required?
circle	string	true
types	object (NotificationTypesType)	true
types[meetingReport]	boolean	false
types[publication]	boolean	true
types[scheduledMeeting]	boolean	true
types[assignation]	boolean	true

Status Codes

Status Code	Description
201	Notification 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

PUT /api/organizations/{organization_id}/members/{member_id}/notifications

Bulk update notifications

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
member_id

Parameters

Parameter	Type	Required?
data[]	array of objects (NotificationDTOType)	true
data[][id]	string	true
data[][circle]	string	true
data[][types]	object (NotificationTypesType)	true
data[][types][meetingReport]	boolean	false
data[][types][publication]	boolean	true
data[][types][scheduledMeeting]	boolean	true
data[][types][assignation]	boolean	true

Status Codes

Status Code	Description
200	Notifications are 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

DELETE /api/organizations/{organization_id}/members/{member_id}/notifications/{id}

Deletes a notification

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
member_id
id

Status Codes

Status Code	Description
204	Notification 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}/members/{member_id}/notifications/{id}

Displays a notification

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
member_id
id

Status Codes

Status Code	Description
200	Displays the notification
404	Notification not found
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}/members/{member_id}/notifications/{id}

Updates a notification

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
member_id
id

Parameters

Parameter	Type	Required?
circle	string	true
types	object (NotificationTypesType)	true
types[meetingReport]	boolean	false
types[publication]	boolean	true
types[scheduledMeeting]	boolean	true
types[assignation]	boolean	true

Status Codes

Status Code	Description
200	Notification 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. Collaboration

GET /api/collaboration/publication

Get collaboration publication

Documentation
Sandbox

Status Codes

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

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/collaboration/publication

Update publication with collaboration token.

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Format	Description
body	string	false
richBody	string	false

Status Codes

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

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/collaboration/publication-revision

Get collaboration publication revision

Documentation
Sandbox

Status Codes

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

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/collaboration/publication-revision

Update publication revision with collaboration token.

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Format	Description
body	string	false
richBody	string	false

Status Codes

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

Input

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}/collaboration/token

Create collaboration token.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
entityId	[a-f0-9]{24}	true		Entity type ID
entityType	(publication\|publication-revision)	true		Entity type

Status Codes

Status Code	Description
201	Collaboration token is returned
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. MFA API

PATCH /api/mfa

Send recovery code to complete Multi-Factor authentication

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Format	Description
recoveryCode	.+	true

Status Codes

Status Code	Description
200	Multi-Factor authentication is generated
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/mfa

Generate Multi-Factor authentication

Documentation
Sandbox

Status Codes

Status Code	Description
200	Multi-Factor authentication is generated
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Headers

= -

Content

= Replaces header if set

Holaspirit API documentation

1. User API

GET /api/me

Status Codes

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/me

Parameters

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /oauth/v2/revoke

Parameters

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

2. Member API

GET /api/organizations/{organization_id}/members

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}/members admin-access

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}/members/bulk admin-access

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}/members/import admin-access

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}/members/{member_id} admin-access

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]