A group of columns defines a table's schema. A column's `field_name` must be unique within a table, follow the column naming requirements, and have a supported data type (`character`, `numeric`, `logical`, `date`, `time`, `datetime`, `file`, or `digital_signature`).
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/wegalvanize-table-columns-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: HighBond API Reference Table columns 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: Table Columns
description: 'A group of columns defines a table''s schema.
A column''s `field_name` must be unique within a table, follow the column naming requirements, and
have a supported data type (`character`, `numeric`, `logical`, `date`, `time`, `datetime`, `file`, or `digital_signature`).'
paths:
/orgs/{org_id}/tables/{table_id}/columns/bulk:
post:
tags:
- Table Columns
operationId: bulkCreateColumns
summary: Create columns in a table
description: 'Add new columns to a table.
Limitations:
* Once a table exists, you cannot change a column''s data type.
* You cannot set a primary key when adding columns to a table.
* Each table can contain a maximum of 500 columns.'
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/tableIdParam'
requestBody:
description: The data required to create a column.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateColumnPayload'
responses:
'201':
description: Created.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/MultiColumnsResponse'
'400':
$ref: '#/components/responses/MissingTableId'
'401':
$ref: '#/components/responses/BadCredentials'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'415':
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/json Content-Type. This request specified application/vnd.api+json.
'
'422':
description: 'Unprocessable entity.
'
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- status: 422
code: record_not_unique
detail: field_name must be unique amoung all columns in a table!
- status: 422
code: unprocessable_entity
detail: Maximum number of 500 Table Columns reached.
delete:
tags:
- Table Columns
operationId: bulkDeleteColumns
summary: Delete table columns
description: 'Delete all the columns in a table.
> **Caution —**
Once you delete columns, the data is permanently removed. You cannot access or restore deleted columns.
Once a table is created and populated with records, deleting a column can break workflows in HighBond that depend on the affected column,
like metrics, visualizations, and triggers.
Limitations: You cannot delete metadata columns (Priority, Status, Published, Publisher Name, Updated, Closed, Assignee, and Workflow Group) or primary key fields.'
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/tableIdParam'
requestBody:
description: An array of column objects.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteColumnPayload'
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'
/orgs/{org_id}/tables/{table_id}/columns:
get:
tags:
- Table Columns
operationId: getColumns
summary: Get columns in a table
description: Get information about the columns in a table.
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/tableIdParam'
responses:
'200':
description: OK.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/MultiColumnsResponse'
'400':
$ref: '#/components/responses/MissingTableId'
'401':
$ref: '#/components/responses/BadCredentials'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'415':
$ref: '#/components/responses/NotJsonapiMediaType'
components:
schemas:
CreateColumnPayload:
type: object
description: The data associated with the resource.
required:
- data
properties:
data:
type: array
description: The data associated with the resource.
items:
type: object
required:
- field_name
- data_type
properties:
field_name:
type: string
description: The underlying name of a column in a table. `field_name` must be unique within a table and follow the <a href="https://help.highbond.com/helpdocs/highbond/en-us/Default.htm#cshid=rm-import-export-results" target="_blank">column naming requirements</a>.
example: account_number
display_name:
type: string
description: The name of the column that is displayed in the table.
maxLength: 256
example: Account number
data_type:
type: string
description: The data type of the column. Supported data types include `character`, `numeric`, `logical`, `date`, `time`, `datetime`, `file`, or `digital_signature`.
example: character
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.
DeleteColumnPayload:
type: object
description: The data associated with the resource.
required:
- data
properties:
data:
type: array
description: The data associated with the resource.
items:
type: object
required:
- field_name
properties:
field_name:
type: string
description: The underlying name of a column in a table. `field_name` must be unique within a table and follow the <a href="https://help.highbond.com/helpdocs/highbond/en-us/Default.htm#cshid=rm-import-export-results" target="_blank">column naming requirements</a>.
example: account_number
Errors:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
MultiColumnsResponse:
type: object
description: The data associated with the resource.
required:
- data
properties:
data:
type: array
description: The data associated with the resource.
items:
type: object
description: The data associated with the resource.
required:
- id
- type
- attributes
- relationships
properties:
id:
type: string
description: The `field_name` of a column.
example: account_number
type:
type: string
description: The classification of the object (`"columns"`).
example: columns
attributes:
type: object
description: The attributes associated with the resource.
properties:
display_name:
type: string
description: The name of the column that is displayed in the table.
maxLength: 256
example: Account number
data_type:
type: string
description: The data type of the column. Supported data types include `character`, `numeric`, `logical`, `date`, `time`, `datetime`, `file`, or `digital_signature`.
example: character
is_primary_key:
type: boolean
description: Specifies if the column is a primary key field. For more information, see <a href="https://help.highbond.com/helpdocs/highbond/en-us/Default.htm#cshid=rm-primary-key" target="_blank">Specifying a primary key</a>.
relationships:
type: object
description: The relationships associated with the resource.
properties:
table:
$ref: '#/components/schemas/RelationshipObject'
example:
table:
data:
id: '300'
type: tables
RelationshipObject:
type: object
description: The object related to the resource.
required:
- data
properties:
data:
type: object
description: The data associated with the related object.
required:
- id
- type
properties:
id:
type: string
description: The ID of the related object.
example: 1
type:
type: string
description: The classification of the related object.
example: collection
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.
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.
NoContent:
description: No content.
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.
'
BadCredentials:
description: Bad credentials.
Forbidden:
description: Forbidden.
MissingTableId:
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, table_id, is missing.
parameters:
orgIdParam:
in: path
name: org_id
description: The ID of the HighBond instance.
required: true
schema:
type: string
example: 1
tableIdParam:
in: path
name: table_id
description: The ID of the table.
required: true
schema:
type: integer
example: 300
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