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?
email	string	false
password	string	false
currentPassword	string	false
lang	string	false
currentOrganization	string	false
timezone	choice	false
country	string	false
intercomInteraction	boolean	false

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	true

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

roleCoreType

Requirement	(facilitator\|lead_link\|rep_link\|secretary)
Description	Select only members who are assigned to the core role

privilege

Requirement	(inactive\|member\|admin)
Description	null

activated

Requirement	(true\|false)
Description	null

assigned

Requirement	(true\|false)
Description	null

autocomplete

Description

null

sort

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

page

Description

null

count

Description

null

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?	Description
firstName	string	false
lastName	string	false
email	string	false
phone	string	false
avatar	string	false
privilege	choice	false	(member\|inactive\|admin)
locations	string	true
skills	string	true

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

Creates many members from a list of emails

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
content	string	true
privilege	choice	true	["inactive","member"]

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 (some fields)

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		(member\|inactive\|admin\|owner)
password	string	false		Required only when nominating a new owner.
translationShow	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
hidePromotion[]	array of strings	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

PUT /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	true
phone	string	false
avatar	string	false
email	string	false		Allowed only for inactive members (visitor access).
privilege	choice	false		(member\|inactive\|admin\|owner)
password	string	false		Required only when nominating a new owner.
translationShow	boolean	true
translationLanguage	choice	true	["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	true
skills[]	array of strings	true
hidePromotion[]	array of strings	true

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\|project\|publication\|role

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

null

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

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

null

page

Description

null

count

Description

null

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[approachingMeeting]	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][approachingMeeting]	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[approachingMeeting]	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

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

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]

Curl Command Line

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

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/organizations/{organization_id}/members/{member_id}