Wegalvanize Sign-offs API
Sign-off on work you have prepared or reviewed, and assign another person as the next reviewer Learn more about sign-offs.
Sign-off on work you have prepared or reviewed, and assign another person as the next reviewer Learn more about sign-offs.
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:wegalvanize-sign-offs-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 Sign Offs 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: Sign-offs
description: 'Sign-off on work you have prepared or reviewed, and assign another person as the next reviewer
Learn more about sign-offs.'
paths:
/orgs/{org_id}/signoffs:
get:
tags:
- Sign-offs
operationId: getSignoffs
summary: Get organization's sign-offs
description: Get a list of all sign-offs within organization.
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/signoffSparseFieldsetParams'
- $ref: '#/components/parameters/signoffIncludeParam'
- $ref: '#/components/parameters/signoffProjectIdFilterParams'
- $ref: '#/components/parameters/signoffProjectStateFilterParams'
- $ref: '#/components/parameters/signoffTargetIdFilterParams'
- $ref: '#/components/parameters/signoffTargetTypeFilterParams'
- $ref: '#/components/parameters/signoffPrearerFilterParams'
- $ref: '#/components/parameters/signoffDetailReviewerFilterParams'
- $ref: '#/components/parameters/signoffGeneralReviewerFilterParams'
- $ref: '#/components/parameters/signoffSupplementalReviewerFilterParams'
- $ref: '#/components/parameters/signoffSpecialtyReviewerFilterParams'
- $ref: '#/components/parameters/signoffNextReviewerFilterParams'
- $ref: '#/components/parameters/pageSizeParam'
- $ref: '#/components/parameters/pageNumberEncodedParam'
responses:
'200':
description: OK.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/GetSignoffsResponse'
'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'
components:
parameters:
signoffProjectIdFilterParams:
in: query
name: filter[project.id]
description: Requesting the API to filter results by project ID. For more information, see <a href="#section/Making-requests">Making requests</a>
required: false
schema:
type: string
example: '1'
signoffGeneralReviewerFilterParams:
in: query
name: filter[general_reviewer.id]
description: Requesting the API to filter results by general reviewer UID. For more information, see <a href="#section/Making-requests">Making requests</a>
required: false
schema:
type: string
example: 3NQ6XzAUxqJMnAQ7n4KF
signoffTargetTypeFilterParams:
in: query
name: filter[target.type]
description: Requesting the API to filter results by target type. For more information, see <a href="#section/Making-requests">Making requests</a>
required: false
schema:
type: string
example: narratives
signoffIncludeParam:
in: query
name: include
description: Requesting the API to return related resources.
required: false
schema:
type: string
enum:
- preparer
- detail_reviewer
- general_reviewer
- supplemental_reviewer
- specialty_reviewer
- next_reviewer
- target
- project
example: preparer,project
signoffPrearerFilterParams:
in: query
name: filter[preparer.id]
description: Requesting the API to filter results by preparer UID. For more information, see <a href="#section/Making-requests">Making requests</a>
required: false
schema:
type: string
example: 3NQ6XzAUxqJMnAQ7n4KF
signoffDetailReviewerFilterParams:
in: query
name: filter[detail_reviewer.id]
description: Requesting the API to filter results by detail reviewer UID. For more information, see <a href="#section/Making-requests">Making requests</a>
required: false
schema:
type: string
example: 3NQ6XzAUxqJMnAQ7n4KF
pageSizeParam:
in: query
name: page[size]
description: The number of items returned per page. Default is 50. Maximum is 100.
required: false
schema:
type: string
example: 25
signoffSupplementalReviewerFilterParams:
in: query
name: filter[supplemental_reviewer.id]
description: Requesting the API to filter results by supplemental reviewer UID. For more information, see <a href="#section/Making-requests">Making requests</a>
required: false
schema:
type: string
example: 3NQ6XzAUxqJMnAQ7n4KF
signoffSpecialtyReviewerFilterParams:
in: query
name: filter[specialty_reviewer.id]
description: Requesting the API to filter results by specialty reviewer UID. For more information, see <a href="#section/Making-requests">Making requests</a>
required: false
schema:
type: string
example: 3NQ6XzAUxqJMnAQ7n4KF
signoffSparseFieldsetParams:
in: query
name: fields[signoffs]
description: Requesting the API to return only the specified fields. For more information, see <a href="#section/Making-requests">Making requests</a>
required: false
schema:
type: string
example: created_at,updated_at,prepared_at,detail_reviewed_at,general_reviewed_at,supplemental_reviewed_at,specialty_reviewed_at,project,target,preparer,detail_reviewer,general_reviewer,supplemental_reviewer,specialty_reviewer,next_reviewer
signoffProjectStateFilterParams:
in: query
name: filter[project.state]
description: Requesting the API to filter results by project state. For more information, see <a href="#section/Making-requests">Making requests</a>
required: false
schema:
type: string
example: active
orgIdParam:
in: path
name: org_id
description: The ID of the HighBond instance.
required: true
schema:
type: string
example: 1
pageNumberEncodedParam:
in: query
name: page[number]
description: The Base64-encoded page number of records to return.
required: false
schema:
type: string
example: Mg==
signoffNextReviewerFilterParams:
in: query
name: filter[next_reviewer.id]
description: Requesting the API to filter results by next reviewer UID. For more information, see <a href="#section/Making-requests">Making requests</a>
required: false
schema:
type: string
example: 3NQ6XzAUxqJMnAQ7n4KF
signoffTargetIdFilterParams:
in: query
name: filter[target.id]
description: Requesting the API to filter results by target ID. For more information, see <a href="#section/Making-requests">Making requests</a>
required: false
schema:
type: string
example: '1'
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.
GetSignoffsResponse:
type: object
description: The data associated with the resource.
required:
- data
properties:
data:
type: array
items:
type: object
description: The data associated with the resource.
required:
- id
- type
- attributes
- relationships
properties:
id:
type: string
description: The ID of the requested resource.
example: '1'
type:
type: string
description: The classification of the object (`"signoffs"`).
example: signoffs
attributes:
type: object
description: The attributes associated with the resource.
properties:
prepared_at:
type: string
description: The timestamp identifying when the signoff was prepared.
example: '2021-01-18T13:17:26Z'
format: date-time
detail_reviewed_at:
type: string
description: The timestamp identifying when the signoff was detail reviewed.
example: '2021-01-18T13:17:26Z'
format: date-time
general_reviewed_at:
type: string
description: The timestamp identifying when the signoff was general reviewed.
example: '2021-01-18T13:17:26Z'
format: date-time
supplemental_reviewed_at:
type: string
description: The timestamp identifying when the signoff was supplemental reviewed.
example: '2021-01-18T13:17:26Z'
format: date-time
specialty_reviewed_at:
type: string
description: The timestamp identifying when the signoff was specialty reviewed.
example: '2021-01-18T13:17:26Z'
format: date-time
created_at:
type: string
description: The timestamp identifying when the signoff was created.
example: '2021-01-18T13:17:26Z'
format: date-time
updated_at:
type: string
description: The timestamp identifying when the signoff was updated.
example: '2021-01-18T13:17:26Z'
format: date-time
relationships:
type: object
description: The relationships associated with the resource.
properties:
preparer:
type: object
description: 'Specifies the user who signed-off as preparer
'
required:
- data
properties:
data:
type: object
description: The data associated with the resource.
required:
- id
- type
properties:
id:
type: string
description: 'The unique identifier (UID) of the user. For more information on obtaining this value, see
<a href="#section/Making-requests">Making requests</a>.
'
example: 3NQ6XzAUxqJMnAQ7n4KF
type:
type: string
description: The classification of the object (`"users"`).
example: users
detail_reviewer:
type: object
description: 'Specifies the user who signed-off as detail reviewer
'
required:
- data
properties:
data:
type: object
description: The data associated with the resource.
required:
- id
- type
properties:
id:
type: string
description: 'The unique identifier (UID) of the user. For more information on obtaining this value, see
<a href="#section/Making-requests">Making requests</a>.
'
example: 3NQ6XzAUxqJMnAQ7n4KF
type:
type: string
description: The classification of the object (`"users"`).
example: users
general_reviewer:
type: object
description: 'Specifies the user who signed-off as general reviewer
'
required:
- data
properties:
data:
type: object
description: The data associated with the resource.
required:
- id
- type
properties:
id:
type: string
description: 'The unique identifier (UID) of the user. For more information on obtaining this value, see
<a href="#section/Making-requests">Making requests</a>.
'
example: 3NQ6XzAUxqJMnAQ7n4KF
type:
type: string
description: The classification of the object (`"users"`).
example: users
supplemental_reviewer:
type: object
description: 'Specifies the user who signed-off as supplemental reviewer
'
required:
- data
properties:
data:
type: object
description: The data associated with the resource.
required:
- id
- type
properties:
id:
type: string
description: 'The unique identifier (UID) of the user. For more information on obtaining this value, see
<a href="#section/Making-requests">Making requests</a>.
'
example: 3NQ6XzAUxqJMnAQ7n4KF
type:
type: string
description: The classification of the object (`"users"`).
example: users
specialty_reviewer:
type: object
description: 'Specifies the user who signed-off as specialty reviewer
'
required:
- data
properties:
data:
type: object
description: The data associated with the resource.
required:
- id
- type
properties:
id:
type: string
description: 'The unique identifier (UID) of the user. For more information on obtaining this value, see
<a href="#section/Making-requests">Making requests</a>.
'
example: 3NQ6XzAUxqJMnAQ7n4KF
type:
type: string
description: The classification of the object (`"users"`).
example: users
next_reviewer:
type: object
description: 'Specifies the user who was assigned as next reviewer
'
required:
- data
properties:
data:
type: object
description: The data associated with the resource.
required:
- id
- type
properties:
id:
type: string
description: 'The unique identifier (UID) of the user. For more information on obtaining this value, see
<a href="#section/Making-requests">Making requests</a>.
'
example: 3NQ6XzAUxqJMnAQ7n4KF
type:
type: string
description: The classification of the object (`"users"`).
example: users
project:
type: object
description: 'Each objective has an associated project or framework. Project/framework is a management system that allows you to define and compile information
for reporting purposes.
'
required:
- data
properties:
data:
type: object
description: The data associated with the resource.
required:
- id
- type
properties:
id:
type: string
description: The ID of the project.
example: '1'
type:
type: string
description: The classification of the object (`"projects"`).
example: projects
target:
type: object
description: Specifies the resource which was signed-off.
required:
- data
properties:
data:
type: object
description: The data associated with a object.
required:
- id
- type
properties:
id:
type: string
description: The ID of the resource.
example: '1'
type:
type: string
description: 'The classification of the object.
A target can have one of the following types: `"narratives"`, `"risk_control_matrices"`, `"walkthrough_summaries"`,
`"walkthroughs"`, `"test_plans"`, `"testing_rounds"`, `"control_test_plans"`, `"control_tests"`,
`"issues"`, `"project_plannings"`, `"project_results"`.
'
example: narratives
links:
type: object
required:
- next
- prev
properties:
next:
type:
- string
- 'null'
description: Next page url
example: /api/resource?page[number]=Mw==
prev:
type:
- string
- 'null'
description: Previous page url
example: null
Errors:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
responses:
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.
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.
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.
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