Board Public APIs

19 Aug 2025
3 Minutes to read

Print
Share
Dark
Light

Board Public APIs

Updated on 19 Aug 2025
3 Minutes to read

Print
Share
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback!

Applies to: All Board Cloud subscriptions

This section gives an overview of Board's Public APIs. To find out more about Board's APIs, read the Client API section, and about the Board SCIM API.

Unless otherwise indicated below, query parameters are case sensitive. OAuth 2.0 Authorization Code with PKCE flow specifications are also supported for the authentication in API requests.

ApiQuery: returns the result of the specified query. It is possible to add querystring parameters for the select.

ApiQuery Submission method: GET

/public/{dbName}/query/{queryName}

Parameters

Parameter	Required?	Description	Parameter Type	Data Type
dbName	Yes	Database name	path	string
queryName	Yes	API query name	path	string
json	No	Set the parameter to "full" to repeat keys for each record returned. Accepted value: "full".	query	string

The queryName parameter value must match an existing API query name in the specified database.

Examples:

Basic
```
?{entity_name}={member_code}
```
```
?year=2012
```
Result: returns all values from 2012.
Multiple different entities
```
?{entity_name}={member_code}&amp;{entity_name}={member_code}
```
```
?year=2012&amp;city=IT01 
```
Result: returns all values from 2012 and city with code IT01.
List of entities of same type
```
?{entity_name}={member_code},{member_code},{member_code}
```
```
?year=2012,2017,2019
```
Result: returns all values from years 2012, 2017 and 2019.
Range of entities of same type
```
?{entity_name}={member_code}..{member_code}
```
```
?year=2015..2019 
```
Result: returns all values from years 2015 to 2019.
Escape with quotation marks
```
?{entity_name}="{member_code}"
```
```
?city="IT01"
```
Result: returns all values from city code IT01.
JSON parameter
```
?json=full 
```
Result: repeats all keys for each returned record, instead of listing all keys once at the beginning of the returned dataset.

Schema: returns a list of entities, of entity members, or of cubes in a specified database.

Schema #1 Submission method: GET

/public/{dbName}/schema/Entities

Parameters

Parameter	Required?	Description	Parameter Type	Data Type
dbName	Yes	Database name	path	string
format	No	The format of the response: tree or flat.	query	string

Schema #2 Submission method: GET

/public/{dbName}/schema/Entities/{name}

Parameters

Parameter	Required?	Description	Parameter Type	Data Type
dbName	Yes	Database name	path	string
name	Yes	Entity name	path	string
skip	No	Bypass a specified number of search results then return the remaining results.	query	integer
take	No	Specify the number of search results to return.	query	integer
searchString	No	Text query. Case insensitive.	query	string

Schema #3 Submission method: GET

/public/{dbName}/schema/Cubes

Parameters

Parameter	Required?	Description	Parameter Type	Data Type
dbName	Yes	Database name	path	string

Procedure: starts the execution of a specified Procedure and returns the Procedure status after its execution.

Execution is only applicable for Data model Procedures and will not work on Capsule Procedures.

Procedure Submission method: POST

/public/{dbName}/procedure/Execute/{procedureName}

Parameters

Parameter	Required?	Description	Parameter Type	Data Type
dbName	Yes	Database name	path	string
procedureName	Yes	Procedure name	path	string

It is possible to trigger the execution of a Procedure with a selection added through query string parameters: the selection will define the scope of the Procedure, just as it happens when the Procedure is triggered from a Capsule Screen which has an active Selection applied.

Examples:

Basic
```
?{entity_name}={member_code}
```
```
?year=2012
```
Result: the Procedure is executed considering the year 2012
Multiple different entities
```
?{entity_name}={member_code}&amp;{entity_name}={member_code}
```
```
?year=2012&amp;city=IT01 
```
Result: the Procedure is executed considering the year 2012 and the city code IT01
List of entities of same type
```
?{entity_name}={member_code},{member_code},{member_code}
```
```
?year=2012,2017,2019
```
Result: the Procedure is executed considering the years 2012, 2017 and 2019
Range of entities of same type
```
?{entity_name}={member_code}..{member_code}
```
```
?year=2015..2019 
```
Result: the Procedure is executed considering the years 2015 to 2019
Escape with quotation marks
```
?{entity_name}="{member_code}"
```
```
?city="IT01"
```
Result: the Procedure is executed considering the city with code IT01

Procedure Submission method: GET

/public/{dbName}/procedure/Status/{sessionId}

Parameters

Parameter	Required?	Description	Parameter Type	Data Type
dbName	Yes	Database name	path	string
sessionId	Yes	The Session ID value included in the response of the execute procedure query	path	string

Response types

Procedure status: running.
```
{
 "status": 1,
 "message": "Running"
}
```
Procedure status: stopped.
```
{
 "status": 0,
 "message": "Stopped"
}
```

Capsule: returns the Capsule tree (with folders, if present) of a specific Capsule by name. By passing a username as a query parameter, the endpoint will return results based on that user's specific authorizations.

Capsule Submission method: GET

/public/capsules/{capsuleName}

Parameters

Parameter	Required?	Description	Parameter Type	Data Type
capsuleName	Yes	Capsule name	path	string
username	No	Username	query	string

FullTextSearch: returns the results of a Full Text Search in the entire Platform (the search is executed in Capsules and Presentations, but it will return also Data models, procedures and anything that matches or contains the search query).

By passing a username as a query parameter, the endpoint will return results based on that user's specific authorizations.

FullTextSearch Submission method: GET

/public/search/{textToSearch}

Parameters

Parameter	Required?	Description	Parameter Type	Data Type
textToSearch	Yes	Text search query	path	string
username	No	Username	query	string

Presentations: returns a list of available Presentations, metadata about a specific Presentation, the list of Slides from a specific Presentation, metadata about a specific Slide, a list of Screen Objects/Layout titles from a specific Slide, values from a single Layout. By passing a username as a query parameter, the endpoint will return results based on that user's specific authorizations.

Presentations #1 Submission method: GET

/public/presentations/{name}

Parameters

Parameter	Required?	Description	Parameter Type	Data Type
name	No	The Presentation name	path	string
username	No	The owner of the Presentation	query	string

Presentations #2 Submission method: GET

/public/presentations/{name}/slides/{slideName}

Parameters

Parameter	Required?	Description	Parameter Type	Data Type
name	Yes	The Presentation name	path	string
slideName	No	The Slide name	path	string
username	No	The owner of the Presentation	query	string

Presentations #3 Submission method: GET

/public/presentations/{name}/slides/{slideName}/toolboxes

Parameters

Parameter	Required?	Description	Parameter Type	Data Type
name	Yes	The Presentation name	path	string
slideName	Yes	The Slide name	path	string
username	No	The owner of the Presentation	query	string

Presentations #4 Submission method: GET

/public/presentations/{name}/slides/{slideName}/toolbox/{toolboxName}

Parameters

Parameter	Required?	Description	Parameter Type	Data Type
name	Yes	The Presentation name	path	string
slideName	Yes	The Slide name	path	string
toolboxName	Yes	The Toolbox name	path	string
username	No	The owner of the Presentation	query	string

The most up-to-date technical documentation is available inside every active Board platform. When connected to the desired platform, click on "Data model" from the main menu, select any data model you have in place, and click on "API queries". Once there, click on "GO TO DOCUMENTATION".

By default, the following quotas apply to all Public API calls:
500 requests per day (this limit can be increased with an additional license. If you need an increase to your quota, please contact your Board Customer Success Manager or Key Account Manager).
10 requests per second.
Board has a default timeout of 100 seconds. If the remote API server does not return a response within 100 seconds, Board closes the connection.

Was this article helpful?

What's Next

Board SCIM API overview

Table of contents