1. Circle API
2. Circle assignation API
3. Role API
4. Role assignation API
5. Authority API
6. Chart API
7. Highlight API
8. Chart View API
9. Domain API

Show/hide List Operations Expand Operations

1. Circle API

GET /api/organizations/{organization_id}/circles

Displays circles

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Displays circles
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}/circles-timespent

Displays circles with time spent details

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Displays circles with time spent details
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}/circles/{circle_id}

Displays a circle

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
circle_id

Status Codes

Status Code	Description
200	Displays a circle
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}/circles/{circle_id}

Updates a circle (some fields)

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
circle_id

Parameters

Parameter	Type	Required?	Description
settings	object (CircleSettingsType)	false	Circle settings.
settings[autonomous]	boolean	true
settings[overrideOpenGovernance]	boolean	true
settings[overrideConsentCategories][]	array of objects (CategorySelectorType)	true
settings[gogDurationDays]	integer	true	Duration in days, after which a GOG with no objection is approved [1, 99]
settings[enableObjectionReason]	boolean	true	Allows to write a message when objecting a Governance out of Governance Meeting
settings[overrideConsentWithoutCategories]	boolean	true
settings[publicItems]	string	true

Status Codes

Status Code	Description
200	Circle 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}/circles/{circle_id}/feed

Displays a circle feed

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
circle_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/organizations/{organization_id}/node-circles

Displays circles

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Displays circles
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}/circles

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}/circles/{circle_id}

Displays stats

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
circle_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. Circle assignation API

POST /api/organizations/{organization_id}/circles/{circle_id}/members

Assigns a member to a circle

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
circle_id

Parameters

Parameter	Type	Required?	Format
member	string	true
level	choice	true	["admin"]
decisionMaker	boolean	true

Status Codes

Status Code	Description
201	Member is assigned
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)
404	Circle not found

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/organizations/{organization_id}/circles/{circle_id}/members/{member_id}

Unassigns a member to a circle

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
circle_id
member_id

Parameters

Parameter	Type	Required?	Format	Description
level	choice	true	["admin"]

Status Codes

Status Code	Description
200	Member is unassigned
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)
404	Member or circle not found

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

3. Role API

GET /api/organizations/{organization_id}/node-roles

Displays node roles

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Roles list
400	Validation violations
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}/node-roles-custom-fields

Displays roles with custom fields

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Roles list
400	Validation violations
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}/node-roles-diagram

Displays nodes roles as diagram

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Roles list as diagram
400	Validation violations
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}/roles

Displays roles

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Roles list
400	Validation violations
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}/roles

Create a role

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?
name	string	true
parent	string	true
purpose	string	false
domains[]	array of strings	false
accountabilities[]	array of strings	false
isCircle	boolean	true
moveInRoles[]	array of objects (RoleSelectorType)	true

Status Codes

Status Code	Description
201	Role 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}/roles-custom-fields

Displays roles with custom fields

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Roles list
400	Validation violations
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}/roles-diagram

Displays roles as diagram

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Roles list as diagram
400	Validation violations
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}/roles/relations

Displays roles' relations.

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

DELETE /api/organizations/{organization_id}/roles/{role_id}

Delete a role, if the role contains other roles, they are moved to the parent circle

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
role_id

Status Codes

Status Code	Description
204	Role 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}/roles/{role_id}

Displays a role

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
role_id

Status Codes

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

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/organizations/{organization_id}/roles/{role_id}

Updates a role

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
role_id

Parameters

Parameter	Type	Required?
name	string	false
purpose	string	false
effortNeeded	float	false
domains[]	array of strings	false
accountabilities[]	array of strings	false
isCircle	boolean	false
moveInRoles[]	array of objects (RoleSelectorType)	false
moveOutRoles[]	array of objects (RoleSelectorType)	false
settings	object (RoleSettingsType)	false
settings[assigner]	boolean	true
settings[lead]	boolean	true
settings[coreRole]	boolean	true
settings[electedRole]	boolean	true
settings[visibleInParentCircle]	boolean	true

Status Codes

Status Code	Description
200	Role 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}/roles/{role_id}/apply

Apply to a role

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
role_id

Parameters

Parameter	Type	Required?	Format	Description
comment	string	true

Status Codes

Status Code	Description
204	Application sent
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)
404	Role not found

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/roles/{role_id}/assignedmembers

Displays role's assigned members

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
role_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/organizations/{organization_id}/roles/{role_id}/feed

Displays a role feed

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
role_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/organizations/{organization_id}/roles/{role_id}/mentions

Displays roles or circles or policies in which the given role is mentioned.

Documentation
Sandbox

Requirements

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

POST /api/organizations/{organization_id}/roles/{role_id}/resign

Resign from a role

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
role_id

Parameters

Parameter	Type	Required?	Format	Description
comment	string	true

Status Codes

Status Code	Description
204	Resignation sent
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)
404	Role not found

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/stats/organizations/{organization_id}/roles/{role_id}

Displays stats

Documentation
Sandbox

Requirements

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

4. Role assignation API

POST /api/organizations/{organization_id}/roles/{role_id}/members

Assigns a member to a role

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
role_id

Parameters

Parameter	Type	Required?	Format	Description
member	string	true
focus	string	false

Status Codes

Status Code	Description
201	Member is assigned
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)
404	Role not found

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/organizations/{organization_id}/roles/{role_id}/members/{member_id}

Unassigns a member to a role

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
role_id
member_id

Status Codes

Status Code	Description
200	Member is unassigned
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)
404	Member or role not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

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

Updates the assigned member for a role

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
role_id
member_id

Parameters

Parameter	Type	Required?	Format	Description
focus	string	false

Status Codes

Status Code	Description
200	Member is updated
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)
404	Member or role not found

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

5. Authority API

GET /api/organizations/{organization_id}/authority/{role_id}

Displays authority data for a role

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
role_id

Status Codes

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

Show/hide List Operations Expand Operations

6. Chart API

GET /api/chart/organizations/{organization_id}/circles/{circle_id}/roles

Displays roles

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
circle_id

Status Codes

Status Code	Description
200	Roles list
400	Validation violations
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

7. Highlight API

GET /api/organizations/{organization_id}/highlights

Displays Highlights

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
category	choice	true	["organization","myroles","status","activity","fte"]
customField	string	true
highlight	string	true		A comma separated list of highlights
page	integer	false
count	integer	false		Between 1 and 100

Status Codes

Status Code	Description
200	Highlights list
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}/highlights

Create a Highlight

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format
name	string	true
color	string	true
fields[]	array of objects (HighlightFieldType)	true
fields[][fieldName]	string	false
fields[][fieldType]	choice	true	["custom","natural"]
fields[][customField]	string	false
fields[][operator]	choice	true	["is","is not","empty","filled","less_than","greater_than"]
fields[][value]	string	false
applyTo	choice	true	["all","circle","role"]
position	integer	false

Status Codes

Status Code	Description
201	Highlight 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}/highlights/{highlight_id}

Delete a Highlight

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
highlight_id

Status Codes

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

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/highlights/{highlight_id}

Displays a highlight

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
highlight_id

Status Codes

Status Code	Description
200	Displays a highlight
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}/highlights/{highlight_id}

Update a Highlight

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
highlight_id

Parameters

Parameter	Type	Required?	Format
name	string	false
color	string	false
fields[]	array of objects (HighlightFieldType)	false
fields[][fieldName]	string	false
fields[][fieldType]	choice	true	["custom","natural"]
fields[][customField]	string	false
fields[][operator]	choice	true	["is","is not","empty","filled","less_than","greater_than"]
fields[][value]	string	false
applyTo	choice	false	["all","circle","role"]
position	integer	false

Status Codes

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

8. Chart View API

GET /api/organizations/{organization_id}/chartviews

Displays ChartViews

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Description
member	string	true
page	integer	false
count	integer	false	Between 1 and 100

Status Codes

Status Code	Description
200	ChartViews list
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}/chartviews

Create a ChartView

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?
name	string	true
chartViewHighlights[]	array of objects (ChartViewHighlightType)	true
chartViewHighlights[][color]	string	false
chartViewHighlights[][highlight]	string	true

Status Codes

Status Code	Description
201	ChartView 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}/chartviews/{chartview_id}

Delete a ChartView

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
chartview_id

Status Codes

Status Code	Description
204	Chart View is deleted
400	Validations errors
401	Unauthorized (i.e. OAuth2 authentication required)
404	ChartView not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/chartviews/{chartview_id}

Displays a chartView

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
chartview_id

Status Codes

Status Code	Description
200	Displays a chartView
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}/chartviews/{chartview_id}

Update a ChartView

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
chartview_id

Parameters

Parameter	Type	Required?
name	string	false
chartViewHighlights[]	array of objects (ChartViewHighlightType)	false
chartViewHighlights[][color]	string	false
chartViewHighlights[][highlight]	string	true

Status Codes

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

9. Domain API

GET /api/organizations/{organization_id}/domains

Displays domains

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

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

GET /api/organizations/{organization_id}/domains/{domain_id}

Displays a Domain

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
domain_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. Circle API

GET /api/organizations/{organization_id}/circles

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/circles-timespent

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/circles/{circle_id}

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/organizations/{organization_id}/circles/{circle_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}/circles/{circle_id}/feed

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/node-circles

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

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

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/stats/organizations/{organization_id}/circles/{circle_id}

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

2. Circle assignation API

POST /api/organizations/{organization_id}/circles/{circle_id}/members

Requirements

Parameters