Show/hide List Operations Expand Operations

Asynchronous

POST /api/async/organizations/{organization_id}/pdf

Build a Pdf Export of the organization

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Format	Description
circle	string	false
tabs	choice	true	["meeting","role"]

Status Codes

Status Code	Description
200
404

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/async/organizations/{organization_id}/spreadsheet

Build a Spreadsheet Export of the organization

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Parameters

Parameter	Type	Required?	Description
circle	string	false
recursive	boolean	false
board	string	false
viewedByMember	string	false
tabs	string	true	A comma separated list of: member\|assignation\|role\|policy\|checklist\|metric\|project\|objective\|action\|task\|publication\|meeting\|timespent\|stats\|stats-circle\|stats-distribution\|stats-summary\|stats-action\|stats-meeting\|stats-objective\|stats-project\|stats-task

Status Codes

Status Code	Description
200
404

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/export/organizations/{organization_id}/jobs/{job_id}/download

Download the output of a job

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
job_id

Status Codes

Status Code	Description
200	Download the output of a job
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}/jobs

Displays jobs

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Status Codes

Status Code	Description
200	Jobs 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}/jobs/{job_id}

Displays a job

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
job_id

Status Codes

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

PDF

GET /api/pdf/organizations/{organization_id}/meetings/{meeting_id}

Get meeting in a PDF

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
meeting_id

Status Codes

Status Code	Description
200	Meeting 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/pdf/organizations/{organization_id}/roles

Get roles in a PDF

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id

Filters

Name

Information

member

Requirement	[0-9a-f]{24}
Description	Selects core and non-core roles of the member.

circles

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

roles

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

Status Codes

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

Show/hide List Operations Expand Operations

Spreadsheet

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

Export a template's members

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
organization_id
template_id

Status Codes

Status Code	Description
200	Template's members are exported
401	Unauthorized (i.e. OAuth2 authentication required)

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Holaspirit API documentation

Asynchronous

POST /api/async/organizations/{organization_id}/pdf

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/async/organizations/{organization_id}/spreadsheet

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/export/organizations/{organization_id}/jobs/{job_id}/download

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/jobs

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/organizations/{organization_id}/jobs/{job_id}

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PDF

GET /api/pdf/organizations/{organization_id}/meetings/{meeting_id}

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/pdf/organizations/{organization_id}/roles

Requirements

Filters

Status Codes

Requirements

Filters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Spreadsheet

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

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]