Show/hide List Operations Expand Operations

1. Meeting API

GET /api/organizations/{organization_id}/meetings

Displays meetings

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Filters

Name

Information

circle

Description

coreMember

Description

member

Description

status

Requirement	[a-z]+(,[a-z]+)*
Description	A comma separated list of: scheduled\|processing\|closed

meetingTemplate

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

recurrence

Requirement	[0-9a-f]{24}
Description

evolutionOutOfMeeting

Requirement	(true\|false)
Description

scheduledAfter

Description

sort

Requirement	([+-](openedAt\|scheduledAt\|updatedAt))
Description

page

Requirement
Description
Default	1

count

Requirement
Description	Between 1 and 100
Default	50

Status Codes

Status Code	Description
200	Meetings are displayed
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}/meetings

Creates a meeting

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
title	string	false
meetingTemplate	string	true
circle	string	true
scheduledAt	datetime	false	yyyy-MM-dd'T'HH:mm:ss
duration	integer	false		in seconds
location	string	true
description	string	true
videoConfUrl	string	true
context	object (ContextType)	true
context[circles][]	array of objects (CircleSelectorType)	false
context[roles][]	array of objects (RoleSelectorType)	false
context[members][]	array of objects (MemberSelectorType)	false
context[funnels][]	array of objects (ContextFunnelType)	false
context[funnels][][circle]	string	false
context[funnels][][role]	string	false
context[funnels][][members][]	array of objects (MemberSelectorType)	false

Status Codes

Status Code	Description
201	Meeting 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}/meetings/{meeting_id}

Deletes a meeting

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
meeting_id

Parameters

Parameter	Type	Required?	Format	Description
transferTensionsTo	string	false

Status Codes

Status Code	Description
204	Meeting is deleted
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}/meetings/{meeting_id}

Displays a meeting

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
meeting_id

Status Codes

Status Code	Description
200	Meeting 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}/meetings/{meeting_id}

Updates a meeting

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
meeting_id

Parameters

Parameter	Type	Required?	Format	Description
title	string	false
secretary	string	false
scheduledAt	datetime	false	yyyy-MM-dd'T'HH:mm:ss
duration	integer	false		in seconds
location	string	false
description	string	false
videoConfUrl	string	false
context	object (ContextType)	false
context[circles][]	array of objects (CircleSelectorType)	false
context[roles][]	array of objects (RoleSelectorType)	false
context[members][]	array of objects (MemberSelectorType)	false
context[funnels][]	array of objects (ContextFunnelType)	false
context[funnels][][circle]	string	false
context[funnels][][role]	string	false
context[funnels][][members][]	array of objects (MemberSelectorType)	false

Status Codes

Status Code	Description
200	Meeting 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}/meetings/{meeting_id}/comment

Creates a meeting comment for a free step

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
meeting_id

Parameters

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

Status Codes

Status Code	Description
201	Meeting 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}/meetings/{meeting_id}/feed

Displays a meeting feed

Documentation
Sandbox

Requirements

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

POST /api/organizations/{organization_id}/meetings/{meeting_id}/import-tensions

Import tensions in meeting

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
meeting_id

Parameters

Parameter	Type	Required?	Format	Description
tensions[]	array of objects (TensionSelectorType)	true

Status Codes

Status Code	Description
200	Tensions imported
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

PATCH /api/organizations/{organization_id}/meetings/{meeting_id}/status

Updates meeting status

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
meeting_id

Parameters

Parameter	Type	Required?	Format	Description
status	choice	false	["scheduled","processing","closed"]
transferTensionsTo	string	false

Status Codes

Status Code	Description
200	Meeting status 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

2. Meeting attendees API

POST /api/organizations/{organization_id}/meetings/{meeting_id}/attendees

Adds an attendee to a meeting

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
meeting_id

Parameters

Parameter	Type	Required?	Format	Description
member	string	true

Status Codes

Status Code	Description
201	Attendee 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}/meetings/{meeting_id}/attendees/{member_id}

Removes an attendee from a meeting

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
meeting_id
member_id

Status Codes

Status Code	Description
201	Attendee is removed
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. Recurrence API

GET /api/organizations/{organization_id}/meetings/recurrences

Displays meetings recurrences

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Filters

Name

Information

meetingTemplate

Description

page

Requirement
Description
Default	1

count

Requirement
Description	Between 1 and 100
Default	50

Status Codes

Status Code	Description
200	Meeting recurrences are displayed
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}/meetings/recurrences

Creates a meeting recurrence

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
title	string	true
rrule	string	true
meetingTemplate	string	true
startAt	datetime	true	yyyy-MM-dd'T'HH:mm:ss
duration	integer	false		in seconds
location	string	true
description	string	true
videoConfUrl	string	true
meeting	string	true
context	object (ContextType)	true
context[circles][]	array of objects (CircleSelectorType)	false
context[roles][]	array of objects (RoleSelectorType)	false
context[members][]	array of objects (MemberSelectorType)	false
context[funnels][]	array of objects (ContextFunnelType)	false
context[funnels][][circle]	string	false
context[funnels][][role]	string	false
context[funnels][][members][]	array of objects (MemberSelectorType)	false

Status Codes

Status Code	Description
201	Meeting recurrence 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}/meetings/recurrences/{recurrence_id}

Deletes a meeting recurrence

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
recurrence_id

Status Codes

Status Code	Description
204	Meeting recurrence 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}/meetings/recurrences/{recurrence_id}

Displays a meeting recurrence

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
recurrence_id

Status Codes

Status Code	Description
200	Meeting 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}/meetings/recurrences/{recurrence_id}

Updates a meeting recurrence

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
recurrence_id

Parameters

Parameter	Type	Required?	Format	Description
title	string	false
rrule	string	false
startAt	datetime	false	yyyy-MM-dd'T'HH:mm:ss
duration	integer	false		in seconds
location	string	false
description	string	false
videoConfUrl	string	false
meeting	string	false

Status Codes

Status Code	Description
200	Recurrence 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. Meeting Template API

GET /api/organizations/{organization_id}/meetingtemplates

Displays meeting templates

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Filters

Name

Information

status

Requirement	[a-z]+(,[a-z]+)*
Description	A comma separated list of: archived\|online\|offline

Status Codes

Status Code	Description
200	Meeting templates are displayed
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}/meetingtemplates

Creates a meeting template

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format
name	string	true
settings[]	array of objects (MeetingTemplateSettingsType)	true
settings[][step]	choice	true	["check-in","action","checklist","metric","objective","project","free","agenda","closing"]
settings[][name]	string	false
settings[][description]	string	false
settings[][output][]	array of choices	true

Status Codes

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

PATCH /api/organizations/{organization_id}/meetingtemplates/{meeting_template_id}

Updates a meeting template

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
meeting_template_id

Parameters

Parameter	Type	Required?	Format
status	choice	false	["archived","hidden","offline","online"]
name	string	false
settings[]	array of objects (MeetingTemplateSettingsType)	false
settings[][step]	choice	true	["check-in","action","checklist","metric","objective","project","free","agenda","closing"]
settings[][name]	string	false
settings[][description]	string	false
settings[][output][]	array of choices	true

Status Codes

Status Code	Description
200	Meeting Template 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. Stats

GET /api/stats/organizations/{organization_id}/governances

Displays stats

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

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

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Holaspirit API documentation

1. Meeting API

GET /api/organizations/{organization_id}/meetings

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

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}/meetings/{meeting_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}/meetings/{meeting_id}

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/organizations/{organization_id}/meetings/{meeting_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}/meetings/{meeting_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}/meetings/{meeting_id}/feed

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}/meetings/{meeting_id}/import-tensions

Requirements

Parameters