APIs (Application Programming Interfaces) in Board enable external systems to interact with the platform by retrieving data, triggering operations, and integrating with other services. Board provides multiple API capabilities, each designed for a specific purpose, such as exposing data, calling external services, or managing users and system configuration.
This article covers:
Board API Types // Board API Integration
Board provides different ways to work with APIs, each designed for a specific purpose.
Accessing Board Data via APIs
These APIs allow external systems to access Board data, manage users, and retrieve system information through secure endpoints.
Public APIs
Public APIs allow external systems to connect to Board through REST endpoints. They are used to retrieve data or interact with Board programmatically.
Board offers the following public APIs:
ApiQuery. Returns the result of the specified query. It is possible to add queryString parameters for the select. For more information on how to create API Queries through the Data Model section, see The API Queries section.
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.
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).
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.
Procedure. Starts the execution of a specified Procedure and returns the Procedure status after its execution.
Schema. Returns a list of Entities, of Entity Members, or of Cubes in a specified Data Model.
For more information, see Board Public APIs.
API Queries
Developers are able to configure specific API Queries to define the data that can be exposed through APIs. For more information on how to create API Queries through the Data Model section, see The API Queries section.
SCIM API
The SCIM API is used for identity management, such as creating and managing users and groups through external identity providers. For more information, see Board SCIM API overview and SCIM API endpoints.
Logs
APIs for Audit Logs allow external systems to retrieve audit log data from Board. They provide access to system activity and events for monitoring, auditing, and integration purposes. For more information, see Audit log and API for Audit Logs.
Calling External APIs from Board Procedures
This capability allows Board to call external APIs and integrate third-party services directly into procedures and processes.
Rest API call Procedure step
The REST API Call step allows Board to call external APIs as part of a Procedure. This is used to integrate external services into Board processes. For more information, see REST API call step.
Choosing the right approach
Use APIs in Board when you need to:
Integrate Board with external applications
Automate data retrieval or processing
Expose Board data for reporting or analysis
Connect Board to third-party services
Use the following table to determine which API capability to use based on your goal:
Type | Description |
Public APIs and API Queries | Retrieve and/or expose Board data externally (from and to external systems) |
REST API call Procedure step | Integrate an external service in a Board Procedure |
SCIM API | Manage users and groups |
How public APIs work in Board
APIs in Board follow a layered approach:
API Queries define the data to expose.
Public APIs provide the endpoints used to retrieve both the data and its related schema.
Authentication mechanisms control access to the APIs.
A typical workflow is:
Define an API Query in Board
Configure authentication (Client API and OAuth 2.0)
Call the API endpoint from an external system
Receive the response in JSON format
Authentication overview
Access to Board APIs is secured through the authentication mechanism: OAuth 2.0 Client Credential. All API requests must be authenticated to ensure that only authorized systems can access Board data.
In Board, a Client API user refers to a user configured with a Client ID and Client Secret required for OAuth 2.0 authentication. For more information, see the Client API section.
For more information on how Board connects to external systems and data sources, see Data Sources.