Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: HighBond API Reference Storyboards API
version: 1.1.0
description: Welcome to the API documentation for HighBond.
x-logo:
url: ./assets/logo.png
altText: HighBond Logo
servers:
- url: '{protocol}://{server}/v1'
variables:
protocol:
default: https
server:
default: apis-us.highbond.com
enum:
- apis-us.highbond.com
- apis-ca.highbond.com
- apis-eu.highbond.com
- apis-ap.highbond.com
- apis-au.highbond.com
- apis-af.highbond.com
- apis-sa.highbond.com
- apis-jp.highbond.com
security:
- bearerToken: []
tags:
- name: Storyboards
description: 'A storyboard is a communication platform that displays multiple visualizations and rich text content in rows and columns. You can use this API to create, configure,
update, and delete storyboards. However, to see your storyboards, you need to log in to HighBond or have someone send you a link to that storyboard.
Learn more about storyboards.'
paths:
/orgs/{org_id}/storyboards:
post:
tags:
- Storyboards
operationId: createStoryboard
summary: Create a storyboard
description: Before creating a storyboard, you must create at least one visualization or metric to include in the presentation. Storyboards are driven by the data in tables, so before you create a storyboard, you should first create the collections, analyses, and tables you need to power it.
parameters:
- $ref: '#/components/parameters/orgIdParam'
requestBody:
description: The data required to create a storyboard.
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/CreateStoryboardPayload'
responses:
'201':
description: Created.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/SingleStoryboardResponse'
'400':
$ref: '#/components/responses/ResourceTypeMismatch'
'401':
$ref: '#/components/responses/BadCredentials'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'415':
$ref: '#/components/responses/NotJsonapiMediaType'
'422':
description: 'Unprocessable entity.
'
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: 422
source:
pointer: /data/attributes/name
code: invalid_resource
detail: can't be blank
/orgs/{org_id}/storyboards/{id}:
get:
tags:
- Storyboards
operationId: getStoryboard
summary: Get a storyboard
description: Get information about a storyboard.
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/resourceIdParam'
responses:
'200':
description: OK.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/SingleStoryboardResponse'
'400':
$ref: '#/components/responses/MissingResourceId'
'401':
$ref: '#/components/responses/BadCredentials'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'415':
$ref: '#/components/responses/NotJsonapiMediaType'
put:
tags:
- Storyboards
operationId: updateStoryboard
summary: Update a storyboard
description: Make changes to a storyboard, like renaming it or applying filters. Once an item is added to the storyboard, any changes automatically appear in the storyboard. You do not need to update storyboards for them to reflect changes in data.
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/resourceIdParam'
requestBody:
description: The data required to update a storyboard.
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UpdateStoryboardPayload'
responses:
'200':
description: OK.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/SingleStoryboardResponse'
'400':
$ref: '#/components/responses/ResourceIdConflict'
'401':
$ref: '#/components/responses/BadCredentials'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'415':
$ref: '#/components/responses/NotJsonapiMediaType'
'422':
description: Unprocessable entity.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: 422
source:
pointer: /data/attributes/name
code: invalid_resource
detail: can't be blank.
delete:
tags:
- Storyboards
operationId: deleteStoryboard
summary: Delete a storyboard
description: 'Permanently delete a storyboard.
> **Caution —**
Once you delete a storyboard, it cannot be recovered.'
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/resourceIdParam'
responses:
'204':
$ref: '#/components/responses/NoContent'
'400':
$ref: '#/components/responses/MissingOrgId'
'401':
$ref: '#/components/responses/BadCredentials'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'415':
$ref: '#/components/responses/NotJsonapiMediaType'
components:
schemas:
Error:
type: object
required:
- status
properties:
status:
type: string
description: The HTTP status code.
source:
type: object
description: Indicates which part of the request document caused the error.
required:
- pointer
properties:
pointer:
type: string
description: 'A JSON Pointer <a href="https://tools.ietf.org/html/rfc6901" target="_blank">(RFC6901)</a> to the associated entity
in the request document.
'
code:
type: string
description: Application-specific error code, expressed as a string value.
title:
type: string
description: A short, human-readable summary of the problem.
detail:
type: string
description: A human-readable explanation specific to this occurrence of the problem.
Errors:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
CreateStoryboardPayload:
type: object
description: The data associated with the resource.
required:
- data
properties:
data:
type: object
description: The data associated with the resource.
required:
- type
- attributes
properties:
type:
type: string
description: The classification of the object (`"storyboards"`).
example: storyboards
attributes:
type: object
description: The attributes associated with the resource.
required:
- name
properties:
name:
type: string
description: The name of the storyboard.
maxLength: 255
example: My first storyboard
config:
type: string
description: 'A JSON string storing the configurations of a storyboard.
See the request sample for details.
'
example: "{\n \"globalFilters\": [\n {\n \"display_name\": \"City\",\n \"field_format\": {},\n \"field_type\": \"character\",\n \"fields\": [\n {\n \"name\": \"City\",\n \"table_id\": 300\n }\n ],\n \"id\": \"cd80\",\n \"is_active\": true,\n \"type\": \"multiSelect\",\n \"values\": [\n \"ALHAMBRA\",\n \"APPLE VALLEY\"\n ]\n }\n ],\n \"panels\": [\n {\n \"id\": \"dbbe\",\n \"text\": \"first story description\",\n \"title\": \"first story title\",\n \"type\": \"text\"\n },\n {\n \"controlTestId\": 300,\n \"id\": \"cf63\",\n \"interpretation_id\": 4001,\n \"type\": \"visualization\",\n \"visualization_id\": \"453d\"\n },\n {\n \"controlId\": 20,\n \"controlTestId\": 300,\n \"id\": \"bdb5\",\n \"metricId\": 5001,\n \"projectid\": 1,\n \"type\": \"metric\"\n }\n ],\n \"positions\": [\n {\n \"col\": 0,\n \"id\": \"ddbe\",\n \"row\": 0\n },\n {\n \"col\": 0,\n \"id\": \"cf63\",\n \"row\": 1\n },\n {\n \"col\": 1,\n \"id\": \"bdb5\",\n \"row\": 1\n }\n ],\n \"rowConfigs\": {\n \"1\": {\n \"height\": 535\n }\n }\n}\n"
SingleStoryboardResponse:
type: object
description: The data associated with the resource.
required:
- data
properties:
data:
type: object
description: The data associated with the resource.
required:
- id
- type
- attributes
properties:
id:
type: string
description: The ID of the storyboard.
example: '5'
type:
type: string
description: The classification of the object (`"storyboards"`).
example: storyboards
attributes:
type: object
description: The attributes associated with the resource.
properties:
name:
type: string
description: The name of the storyboard.
maxLength: 255
example: My first storyboard
config:
type: string
description: 'A JSON string storing the configurations of a storyboard.
See the request sample for details.
'
example: "{\n \"globalFilters\": [\n {\n \"display_name\": \"City\",\n \"field_format\": {},\n \"field_type\": \"character\",\n \"fields\": [\n {\n \"name\": \"City\",\n \"table_id\": 300\n }\n ],\n \"id\": \"cd80\",\n \"is_active\": true,\n \"type\": \"multiSelect\",\n \"values\": [\n \"ALHAMBRA\",\n \"APPLE VALLEY\"\n ]\n }\n ],\n \"panels\": [\n {\n \"id\": \"dbbe\",\n \"text\": \"first story description\",\n \"title\": \"first story title\",\n \"type\": \"text\"\n },\n {\n \"controlTestId\": 300,\n \"id\": \"cf63\",\n \"interpretation_id\": 4001,\n \"type\": \"visualization\",\n \"visualization_id\": \"453d\"\n },\n {\n \"controlId\": 20,\n \"controlTestId\": 300,\n \"id\": \"bdb5\",\n \"metricId\": 5001,\n \"projectid\": 1,\n \"type\": \"metric\"\n }\n ],\n \"positions\": [\n {\n \"col\": 0,\n \"id\": \"ddbe\",\n \"row\": 0\n },\n {\n \"col\": 0,\n \"id\": \"cf63\",\n \"row\": 1\n },\n {\n \"col\": 1,\n \"id\": \"bdb5\",\n \"row\": 1\n }\n ],\n \"rowConfigs\": {\n \"1\": {\n \"height\": 535\n }\n }\n}\n"
created_at:
type: string
description: The date when the storyboard was created.
example: '2019-02-09T13:17:26Z'
format: date-time
updated_at:
type: string
description: The date when the storyboard was updated.
example: '2019-03-18T22:02:05Z'
format: date-time
UpdateStoryboardPayload:
type: object
description: The data associated with the resource.
required:
- data
properties:
data:
type: object
description: The data associated with the resource.
required:
- id
- type
- attributes
properties:
id:
type: string
description: The ID of the storyboard.
example: '1'
type:
type: string
description: The classification of the object (`"storyboards"`).
example: storyboards
attributes:
type: object
description: The attributes associated with the resource.
required:
- name
properties:
name:
type: string
description: The name of the storyboard.
maxLength: 255
example: My first storyboard
config:
type: string
description: 'A JSON string storing the configurations of a storyboard.
See the request sample for details.
'
example: "{\n \"globalFilters\": [\n {\n \"display_name\": \"City\",\n \"field_format\": {},\n \"field_type\": \"character\",\n \"fields\": [\n {\n \"name\": \"City\",\n \"table_id\": 300\n }\n ],\n \"id\": \"cd80\",\n \"is_active\": true,\n \"type\": \"multiSelect\",\n \"values\": [\n \"ALHAMBRA\",\n \"APPLE VALLEY\"\n ]\n }\n ],\n \"panels\": [\n {\n \"id\": \"dbbe\",\n \"text\": \"first story description\",\n \"title\": \"first story title\",\n \"type\": \"text\"\n },\n {\n \"controlTestId\": 300,\n \"id\": \"cf63\",\n \"interpretation_id\": 4001,\n \"type\": \"visualization\",\n \"visualization_id\": \"453d\"\n },\n {\n \"controlId\": 20,\n \"controlTestId\": 300,\n \"id\": \"bdb5\",\n \"metricId\": 5001,\n \"projectid\": 1,\n \"type\": \"metric\"\n }\n ],\n \"positions\": [\n {\n \"col\": 0,\n \"id\": \"ddbe\",\n \"row\": 0\n },\n {\n \"col\": 0,\n \"id\": \"cf63\",\n \"row\": 1\n },\n {\n \"col\": 1,\n \"id\": \"bdb5\",\n \"row\": 1\n }\n ],\n \"rowConfigs\": {\n \"1\": {\n \"height\": 535\n }\n }\n}\n"
responses:
NotFound:
description: Not found.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: '404'
title: Not Found
detail: The requested resource does not exist.
MissingResourceId:
description: Bad request.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: 400
code: parameter_missing
title: Parameter missing
detail: The required parameter, id, is missing.
MissingOrgId:
description: Bad request.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: 400
code: parameter_missing
title: Parameter missing
detail: The required parameter, org_id, is missing.
ResourceTypeMismatch:
description: Bad request.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: 400
code: resource_type_mismatch
title: Resource type mismatch
detail: 'The requested data type, a-bad-type, is incompatible with the endpoint.
'
Forbidden:
description: Forbidden.
NotJsonapiMediaType:
description: Unsupported media type.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: 415
code: unsupported_media_type
title: Unsupported media type
detail: 'The endpoint supports only the application/vnd.api+json Content-Type. This request specified application/json.
'
ResourceIdConflict:
description: Bad request.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: 400
code: resource_id_conflict
title: Resource ID conflict
detail: 'The id specified in the request body, 1, conflicts with
the id specified in the path, 101.
'
NoContent:
description: No content.
BadCredentials:
description: Bad credentials.
parameters:
orgIdParam:
in: path
name: org_id
description: The ID of the HighBond instance.
required: true
schema:
type: string
example: 1
resourceIdParam:
in: path
name: id
description: The ID of the requested resource.
required: true
schema:
type: string
example: 9999
securitySchemes:
bearerToken:
description: 'HighBond offers the industry-standard OAuth 2.0 flow for connecting to the HighBond platform. OAuth 2.0 provides a
safe and secure way to access data, while protecting your account credentials.
'
type: http
scheme: bearer
bearerFormat: oauth2
x-tagGroups:
- name: Core resources
tags:
- Robots Agents
- Robots
- Robot Tasks
- Robot Jobs
- Robot Apps
- Robot Script Versions
- Robot Activations
- Robot Files
- Robot Working Files
- Robot Collaborators
- Robots Folders Collaborators
- Robot Users
- Robots Folders
- Storyboards
- Collections
- Questionnaires
- Analyses
- Surveys
- Event Reports
- Tables
- Table columns
- Records
- Record columns
- Record statuses
- Interpretations
- Metrics
- Workflow Groups
- Results Users
- Results Triggers
- Project types
- Custom attributes
- Request item statuses
- Projects
- Projects Admin
- Planning files
- Results files
- Objectives
- Narratives
- Risks
- Controls
- Control performance schedules
- Mitigations
- Control test plans
- Control tests
- Attachments
- Walkthroughs
- Issues
- Actions
- Collaborators
- Request Items
- To-dos
- Sign-offs
- Entities
- Scheduler Filters
- Frameworks
- Handlers
- Workflows in Asset Inventory/Asset Manager
- Asset types
- Asset record types
- Attribute types
- Assets
- Asset Relationships
- Asset records
- Asset Record Relationships
- Events
- Template Toolkits
- Toolkits
- Roles
- Role Deletion
- Compliance Maps
- Time entries
- Non-project time categories
- Timesheets
- Importer
- System Users
- Organizations
- Impact Reports
- Activities
- Users
- Groups
- Scheduled Users
- Scheduled Projects
- Scheduled Hours
- Extract
- Strategy