Show/hide List Operations Expand Operations

1. Organization API

POST /api/organizations

Creates an organization

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Format	Description
name	string	true
country	choice	true	["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]	The 2-letter uppercase country code
firstName	string	false
lastName	string	false
phone	string	false
onboarding	object (OnboardingType)	true
onboarding[project]	string	true
onboarding[description]	string	true
onboarding[knowledge]	string	true
onboarding[organizationSize]	string	true
onboarding[methodology]	string	true
onboarding[methodology2]	string	true
onboarding[benefits]	string	true
onboarding[benefits2]	string	true
onboarding[origin]	string	true
onboarding[origin2]	string	true
onboarding[roleInOrganization]	string	true
onboarding[utmSource]	string	true
onboarding[utmMedium]	string	true
onboarding[utmCampaign]	string	true
onboarding[holacracyCoreRoles]	boolean	true
onboarding[step]	integer	true
enableEmails	boolean	true

Status Codes

Status Code	Description
200	Organization is created
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

DELETE /api/organizations/{organization_id} admin-access

Deletes an organization

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
204	Organization 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}

Displays an organization

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Displays an organization
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} admin-access

Updates the organization information

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
name	string	false
country	choice	false	["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]	The 2-letter uppercase country code
enableEmails	boolean	false		When deactivated, no emails are sent to the members, except the owner and admins
enableMediaUpload	boolean	false		When deactivated, disallow users to upload files
enableObjectionReason	boolean	false		Allows to write a message when objecting a Governance out of Governance Meeting
gogDurationDays	integer	false		Duration in days, after which a GOG with no objection is approved [1, 99]
ratification	string	false		URI to the constitution ratification document
gdprInformation	object (GdprInformationType)	false
gdprInformation[organizationName]	string	true
gdprInformation[address]	string	true
gdprInformation[name]	string	true
gdprInformation[phone]	string	true
gdprInformation[email]	string	true
settings	object (SettingsType)	false		Organization settings.
settings[isPublic]	boolean	true
settings[publicItems]	string	true
settings[noEmailChange]	boolean	true
settings[satismeterActivated]	boolean	true
settings[openGovernance]	boolean	true
settings[securedDomains][]	array of strings	true
settings[authentication]	choice	true	["google","saml","workspace"]
settings[enforceSecurity]	boolean	true
settings[securedDomainsInvitationEmails]	boolean	true
settings[restrictInvitationDomains]	boolean	true
settings[graphHolacracy]	boolean	true
settings[graphSociocracy]	boolean	true
settings[graphRelations]	boolean	true
settings[defaultGraph]	choice	true	["graphHolacracy","graphSociocracy","graphRelations"]
settings[defaultPublicGraph]	choice	true	["graphHolacracy","graphSociocracy","graphRelations"]
settings[samlCreatePrivilege]	choice	true	["inactive","member"]
settings[scimCreatePrivilege]	choice	true	["inactive","member"]
settings[scimSoftToHardDelete]	boolean	true
settings[forceRoleElected]	boolean	true
settings[overrideElectedRole]	boolean	true
settings[overrideAssignationRole]	boolean	true
settings[overrideOpenGovernance]	boolean	true
settings[consentCategories][]	array of objects (CategorySelectorType)	true
settings[consentWithoutCategories]	boolean	true
settings[overrideConsentWithoutCategories]	boolean	true
theme	string	false		Organization theme.
status	choice	false	["pending","validated"]
onboarding	object (OnboardingType)	false
onboarding[project]	string	true
onboarding[description]	string	true
onboarding[knowledge]	string	true
onboarding[organizationSize]	string	true
onboarding[methodology]	string	true
onboarding[methodology2]	string	true
onboarding[benefits]	string	true
onboarding[benefits2]	string	true
onboarding[origin]	string	true
onboarding[origin2]	string	true
onboarding[roleInOrganization]	string	true
onboarding[utmSource]	string	true
onboarding[utmMedium]	string	true
onboarding[utmCampaign]	string	true
onboarding[holacracyCoreRoles]	boolean	true
onboarding[step]	integer	true
logo	string	false
publicSlug	string	false
multiFactorAuthenticationConfiguration	object (ManageMultiFactorAuthenticationType)	false		Multi-Factor Authentication configuration.
multiFactorAuthenticationConfiguration[activated]	boolean	true
multiFactorAuthenticationConfiguration[startDate]	datetime	false	yyyy-MM-dd'T'HH:mm:ss
multiFactorAuthenticationConfiguration[mandatoryForMemberPrivilege][]	array of choices	false

Status Codes

Status Code	Description
200	Organization is updated
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}/app/action

Updates the action app configuration

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
activated	boolean	false

Status Codes

Status Code	Description
200	Action app configuration is updated
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}/app/holacracy

Updates the Holacracy app configuration

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?
activated	boolean	false
allowCoreRoleOverride	boolean	false
allowCircleLinksOverride	boolean	false
allowAssignationOverride	boolean	false
allowEvolutionOutsideMeeting	boolean	false
allowMeetingTemplateOverride	boolean	false
practiceSupport	boolean	false
tensionInbox	boolean	false
emailSequence	boolean	false
objectionFunnel	boolean	false
administrators[]	array of objects (MemberSelectorType)	false

Status Codes

Status Code	Description
200	Holacracy app configuration is updated
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}/app/inbox

Updates the inbox app configuration

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
activated	boolean	false
wording	choice	false	["tension","driver","spark","note"]

Status Codes

Status Code	Description
200	Inbox app configuration is updated
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}/app/meeting

Updates the meeting app configuration

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
activated	boolean	false

Status Codes

Status Code	Description
200	Meeting app configuration is updated
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}/app/objective

Updates the objective app configuration

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
activated	boolean	false

Status Codes

Status Code	Description
200	Objective app configuration is updated
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}/app/project

Updates the project app configuration

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
activated	boolean	false
showAllBoards	boolean	false

Status Codes

Status Code	Description
200	Project app configuration is updated
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}/app/timespent

Updates the timespent app configuration

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?
activated	boolean	false
inactiveMembersActivated	boolean	false
daysPerMonth	float	false

Status Codes

Status Code	Description
200	Action app configuration is updated
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}/app/translation

Updates the translation app configuration

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format
activated	boolean	false
languages[]	array of choices	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"]
translators[]	array of objects (MemberSelectorType)	false

Status Codes

Status Code	Description
200	Translation app configuration is updated
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}/circles/{circle_id} admin-access

Updates the organization's general circle information

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
circle_id

Parameters

Parameter	Type	Required?	Format
name	string	false
purpose	string	false
domains[]	array of objects (DomainProposalType)	true
domains[][action]	choice	true	["create","copy","delete","elect","restructure","review","transform","update"]
domains[][id]	string	true
domains[][description]	string	true
accountabilities[]	array of objects (AccountabilityProposalType)	true
accountabilities[][action]	choice	true	["create","copy","delete","elect","restructure","review","transform","update"]
accountabilities[][id]	string	true
accountabilities[][description]	string	true

Status Codes

Status Code	Description
200	Organization's general circle is updated
400	Circle is not the general circle of the organization
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}/diagram-ai

Generate Diagram with OpenAI

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Organization is generated
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}/diagram-ai/resume

Generate Diagram with OpenAI

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Organization is generated
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}/resend-invitations admin-access

Resend all pending invitations of the organization

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Invitations are resent
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}/search-global

Search the organization

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
query
organization_id

Filters

Name

Information

types

Description

taskType

Requirement	(action\|project)
Description

Status Codes

Status Code	Description
200	Search is queried
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}/search/mention

Search the organization

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
query
organization_id

Filters

Name

Information

types

Description

A comma separated list types member|role

circle

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

Status Codes

Status Code	Description
200	Search is queried
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}/tokens

Displays an organization's tokens

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Displays an organization's tokens
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/stats/organizations/{organization_id}

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

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

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

Displays apps 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

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

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

Displays time spent 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

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

2. Media API

GET /api/organizations/{organization_id}/backups

Displays backups

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Backup's 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}/medias upload

Creates a media

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
file	file	true

Status Codes

Status Code	Description
201	Media 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}/medias/{id} upload

Updates a media

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
id

Parameters

Parameter	Type	Required?	Format	Description
file	file	true

Status Codes

Status Code	Description
200	Media 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}/preset-images upload

Creates a preset image

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
file	file	true

Status Codes

Status Code	Description
201	Preset image 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}/preset-images/{preset_image_id}

Delete a preset image

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
preset_image_id

Status Codes

Status Code	Description
204	Preset image 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}/preset-images/{preset_image_id} upload

Updates a preset image

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
preset_image_id

Parameters

Parameter	Type	Required?	Format	Description
file	file	false

Status Codes

Status Code	Description
200	Preset image 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. Subscription API

GET DEPRECATED /api/available-plans

Gets available Chargebee plans.

Documentation
Sandbox

Status Codes

Status Code	Description
200	Plans list
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

POST /api/organizations/{organization_id}/stripe admin-access

Creates or updates a subscription for the given organization and return the checkout page url.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
plan	choice	true	["start","rise","scale"]
quantity	integer	true
frequency	choice	true	["monthly","yearly"]
apps[]	array of choices	true
addons[]	array of choices	true
translation	string	true
country	choice	true	["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]	The 2-letter uppercase country code, only when starting a new subscription
vatIdNumber	string	true		Only when starting a new subscription
coupon	string	true

Status Codes

Status Code	Description
201	Subscription is created or updated for the organization, and ready to be checked out.
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}/stripe/coupon/{coupon} admin-access

Retrieve information about a coupon.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
coupon	\w+
organization_id

Status Codes

Status Code	Description
200	Information about the coupon.
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}/stripe/current admin-access

Returns au URL to access billing info.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Gets URL
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}/stripe/estimate admin-access

Creates an estimate for the current subscription for the given organization.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format
plan	choice	true	["start","rise","scale"]
quantity	integer	true
frequency	choice	true	["monthly","yearly"]
coupon	string	true
apps[]	array of choices	true
addons[]	array of choices	true
translation	string	true

Status Codes

Status Code	Description
201	Estimate has been 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}/stripe/estimate/prorata admin-access

Creates a prorata estimate for the current subscription for the given organization.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format
plan	choice	true	["start","rise","scale"]
quantity	integer	true
frequency	choice	true	["monthly","yearly"]
coupon	string	true
apps[]	array of choices	true
addons[]	array of choices	true
translation	string	true

Status Codes

Status Code	Description
201	Estimate has been 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}/stripe/portal-access admin-access

Returns au URL to access billing info.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Gets URL
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 DEPRECATED /api/organizations/{organization_id}/subscription admin-access

Cancel the premium subscription for the given organization

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
reason	string	true

Status Codes

Status Code	Description
200	Premium subscription has been cancelled.
400	Validation 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 DEPRECATED /api/organizations/{organization_id}/subscription admin-access

Updates subscription return status.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
hostedPageId	\S+	true		Hosted page ID
hostedPageState	(succeeded\|failed\|cancelled)	true		Hosted page state

Status Codes

Status Code	Description
200	Premium subscription 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 DEPRECATED /api/organizations/{organization_id}/subscription admin-access

Creates a premium subscription for the given organization and return the checkout page url.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
quantity	integer	true		\d+
frequency	choice	true	["monthly","yearly"]	(monthly\|yearly)

Status Codes

Status Code	Description
201	Premium subscription is created for the organization, and ready to be checked out.
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 DEPRECATED /api/organizations/{organization_id}/subscription admin-access

Updates the subscription's plan for the given organization.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
quantity	integer	true		\d+
frequency	choice	true	["monthly","yearly"]	(monthly\|yearly)

Status Codes

Status Code	Description
200	Subscription's plan is updated for 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 DEPRECATED /api/organizations/{organization_id}/subscription/estimate admin-access

Creates an estimate for the current subscription for the given organization.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
quantity	integer	true		\d+
frequency	choice	true	["monthly","yearly"]	(monthly\|yearly)

Status Codes

Status Code	Description
201	Estimate has been created for 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 DEPRECATED /api/organizations/{organization_id}/subscription/portal-access admin-access

Generate SSO connection and returns au URL to access billing info.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Connection opened
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}/trial/{app} admin-access

Starts a trial for an app for 15 days.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
app	(meeting\|objective\|project)
organization_id

Status Codes

Status Code	Description
200	Trial is started for app
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/plans

Gets available plans.

Documentation
Sandbox

Status Codes

Status Code	Description
200	Plans list
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

Show/hide List Operations Expand Operations

5. Comment API

DELETE /api/organizations/{organization_id}/comments/{activity_id}

Deletes a comment

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
activity_id

Status Codes

Status Code	Description
204	Comment 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}/comments/{activity_id}

Updates a comment

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
activity_id

Parameters

Parameter	Type	Required?	Format	Description
comment	string	false

Status Codes

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

6. Template API

GET /api/organizations/{organization_id}/templates

Displays templates

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Templates 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}/templates

Creates a template

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?
name	string	true
purpose	string	false
domains[]	array of strings	false
accountabilities[]	array of strings	false
settings	object (SettingsType)	true
settings[automaticallyCreateInNewCircle]	boolean	true
settings[possibleInAnchorCircle]	boolean	true
settings[visibleInParentCircle]	boolean	true
settings[assigner]	boolean	true
settings[lead]	boolean	true
settings[coreRole]	boolean	true
settings[electedRole]	boolean	true
settings[locked]	boolean	false
role	string	false

Status Codes

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

DELETE /api/organizations/{organization_id}/templates/{template_id}

Deletes a template

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
template_id

Status Codes

Status Code	Description
204	Template 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}/templates/{template_id}

Displays a template

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
template_id

Status Codes

Status Code	Description
200	Template 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}/templates/{template_id}

Updates a template

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
template_id

Parameters

Parameter	Type	Required?
name	string	false
purpose	string	false
domains[]	array of strings	false
accountabilities[]	array of strings	false
settings	object (SettingsType)	false
settings[automaticallyCreateInNewCircle]	boolean	true
settings[possibleInAnchorCircle]	boolean	true
settings[visibleInParentCircle]	boolean	true
settings[assigner]	boolean	true
settings[lead]	boolean	true
settings[coreRole]	boolean	true
settings[electedRole]	boolean	true
settings[locked]	boolean	false
role	string	false

Status Codes

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

GET /api/stats/organizations/{organization_id}/templates/{template_id}

Displays stats

Documentation
Sandbox

Requirements

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

8. Attribute API

GET /api/organizations/{organization_id}/attributes

Displays attributes

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
attributeType	(skills\|locations)
organization_id

Filters

Name

Information

autocomplete

Description

page

Requirement
Description
Default	1

count

Requirement
Description	Between 1 and 100
Default	50

sort

Requirement	([+-]alpha)
Description

Status Codes

Status Code	Description
200	Displays an attribute
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}/attributes

Creates some attributes

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
attributeType	choice	true	["skills","locations"]
values[]	array of strings	true

Status Codes

Status Code	Description
201	Attributes 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}/attributes/{attribute_id}

Deletes an attribute

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
attribute_id

Status Codes

Status Code	Description
204	Attribute 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

Show/hide List Operations Expand Operations

9. Category API

GET /api/organizations/{organization_id}/categories

Displays categories

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Filters

Name

Information

autocomplete

Description

page

Requirement
Description
Default	1

count

Requirement
Description	Between 1 and 100
Default	50

Status Codes

Status Code	Description
200	Categories 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}/categories

Creates a category

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?
name	string	true
description	string	false
color	string	true

Status Codes

Status Code	Description
201	Category 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}/categories/{category_id}

Deletes a category

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
category_id

Status Codes

Status Code	Description
204	Category 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}/categories/{category_id}

Displays a category

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
category_id

Status Codes

Status Code	Description
200	Category 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}/categories/{category_id}

Updates a category

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
category_id

Parameters

Parameter	Type	Required?
name	string	false
description	string	false
color	string	false

Status Codes

Status Code	Description
200	Category 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. Organization API

POST /api/organizations

Parameters

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/organizations/{organization_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}

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/organizations/{organization_id} admin-access

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/organizations/{organization_id}/app/action

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/organizations/{organization_id}/app/holacracy

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/organizations/{organization_id}/app/inbox

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/organizations/{organization_id}/app/meeting

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL