Wegalvanize

Wegalvanize Narratives API

A narrative is a description of a business process or area under review. Narratives are also known as policies, IT policies, process narratives, process descriptions, or control guides. > **Note:** > * To access narratives using the API, the narratives tab must be enabled in the project type associated with the project or framework. > > Narratives located in such resources can be accessed using the API: > * In Internal Control workflow projects that have an "active" state > * In frameworks Learn more about narratives.

GitHub OpenAPI

Operations 5

GET /orgs/{org_id}/objectives/{objective_id}/narratives Get narratives #
POST /orgs/{org_id}/objectives/{objective_id}/narratives Create a narrative #
GET /orgs/{org_id}/narratives/{id} Get a narrative #
PATCH /orgs/{org_id}/narratives/{id} Update a narrative #
DELETE /orgs/{org_id}/narratives/{id} Delete a narrative #

Documentation

📖
APIReference
https://docs-apis.highbond.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/wegalvanize/refs/heads/main/openapi/wegalvanize-narratives-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/wegalvanize:wegalvanize-narratives-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

wegalvanize-narratives-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: HighBond API Reference Narratives 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: Narratives
  description: A narrative is a description of a business process or area under review.
paths:
  /orgs/{org_id}/objectives/{objective_id}/narratives:
    get:
      tags:
      - Narratives
      operationId: getNarratives
      summary: Get narratives
      description: Get all narratives in an objective.
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/objectiveIdParam'
      - $ref: '#/components/parameters/narrativeSparseFieldsetParams'
      - $ref: '#/components/parameters/pageSizeParam'
      - $ref: '#/components/parameters/pageNumberEncodedParam'
      responses:
        '200':
          description: OK.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetNarrativesResponse'
        '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'
    post:
      tags:
      - Narratives
      operationId: createNarrative
      summary: Create a narrative
      description: 'Create a new narrative in an existing objective.


        Limitations:

        * Each objective in a project or framework can contain a maximum of 1000 narratives.

        * You cannot update narrative title to value that has more than 60 characters'
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/objectiveIdParam'
      - $ref: '#/components/parameters/narrativeSparseFieldsetParams'
      requestBody:
        description: The data required to create a narrative.
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/CreateNarrativeRequest'
      responses:
        '201':
          description: Created.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetNarrativeResponse'
        '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/title
                  code: invalid_resource
                  detail: is too long (maximum is 60 characters)
  /orgs/{org_id}/narratives/{id}:
    get:
      tags:
      - Narratives
      operationId: getNarrative
      summary: Get a narrative
      description: 'Get information about a narrative.


        Limitation:

        Existing Citation Mode highlights and links are not displayed in the `description` field.'
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/resourceIdParam'
      - $ref: '#/components/parameters/narrativeSparseFieldsetParams'
      responses:
        '200':
          description: OK.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetNarrativeResponse'
        '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'
    patch:
      tags:
      - Narratives
      operationId: updateNarrative
      summary: Update a narrative
      description: 'Make changes to a narrative in objective, like renaming the narrative title or updating the narrative description.


        Limitations:

        * You cannot update narrative title to value that has more than 60 characters'
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/resourceIdParam'
      - $ref: '#/components/parameters/narrativeSparseFieldsetParams'
      requestBody:
        description: The data required to update a narrative.
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/UpdateNarrativeRequest'
      responses:
        '200':
          description: OK.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetNarrativeResponse'
        '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'
        '422':
          description: 'Unprocessable entity.

            '
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                - status: 422
                  source:
                    pointer: /data/attributes/title
                  code: invalid_resource
                  detail: is too long (maximum is 60 characters)
    delete:
      tags:
      - Narratives
      operationId: deleteNarratrive
      summary: Delete a narrative
      description: 'Permanently delete a narrative from an objective.


        Limitations:

        * You cannot delete the narrative if it is included in an existing certification program.

        * You cannot delete the narrative if the objective it belongs to has been checked out using

        Offline Projects or the

        HighBond iPad app.


        > **Caution —**

        Deleting a narrative is permanent. Once deleted, you cannot access or restore the narrative.'
      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:
    Errors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    GetNarrativeResponse:
      type: object
      required:
      - data
      properties:
        data:
          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 type of narrative (`"narratives"`).
              example: narratives
            attributes:
              type: object
              description: The attributes associated with the resource.
              required:
              - title
              properties:
                title:
                  type: string
                  description: The title of the narrative.
                  maxLength: 60
                  example: Narrative title
                description:
                  type: string
                  description: A detailed description of the narrative.
                  maxLength: 524288
                  example: Narrative description
                position:
                  type: integer
                  format: int64
                  description: 'The value that determines the order in which it is displayed in the index action. `position` must be a value between `1` and `2147483647`.

                    '
                  example: 1
                created_at:
                  type: string
                  description: The timestamp identifying when the narrative was created.
                  example: '2019-02-09T13:17:26Z'
                  format: date-time
                updated_at:
                  type: string
                  description: The timestamp identifying when the narrative was last updated.
                  example: '2019-02-09T13:17:26Z'
                  format: date-time
            relationships:
              type: object
              description: The relationships associated with the resource.
              required:
              - objective
              properties:
                objective:
                  type: object
                  description: 'Each narrative has an associated objective. Objectives are the basis of a project or framework.

                    They are also the organizing containers for the work done in a project or framework.

                    '
                  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 objective.
                          example: '1'
                        type:
                          type: string
                          description: The classification of the object (`"objectives"`).
                          example: objectives
                framework_origin:
                  type: object
                  description: 'In the Projects app, a project `narrative` can have a related counterpart in an associated framework. The `framework_origin` attribute allows you to associate an `narrative` in a project with its related counterpart in a framework.

                    '
                  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 parent control.
                          example: '1'
                        type:
                          type: string
                          description: The classification of the object (`"narratives"`).
                          example: narratives
    UpdateNarrativeRequest:
      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 requested resource.
              example: '1'
            type:
              type: string
              description: The type of narrative (`"narratives"`).
              example: narratives
            attributes:
              type: object
              description: The attributes associated with the resource.
              required:
              - title
              properties:
                title:
                  type: string
                  description: The title of the narrative.
                  maxLength: 60
                  example: Narrative title
                description:
                  type: string
                  description: A detailed description of the narrative.
                  maxLength: 524288
                  example: Narrative description
                position:
                  type: integer
                  format: int64
                  description: 'The value that determines the order in which it is displayed in the index action. `position` must be a value between `1` and `2147483647`.

                    '
                  example: 1
            relationships:
              type: object
              description: The attributes associated with the resource.
              properties:
                framework_origin:
                  type: object
                  description: 'In the Projects app, a project `narrative` can have a related counterpart in an associated framework. The `framework_origin` attribute allows you to associate an `narrative` in a project with its related counterpart in a framework.

                    '
                  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 parent control.
                          example: '1'
                        type:
                          type: string
                          description: The classification of the object (`"narratives"`).
                          example: narratives
    GetNarrativesResponse:
      type: object
      required:
      - data
      - links
      properties:
        data:
          type: array
          description: Array of narratives
          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 type of narrative (`"narratives"`).
                example: narratives
              attributes:
                type: object
                description: The attributes associated with the resource.
                required:
                - title
                properties:
                  title:
                    type: string
                    description: The title of the narrative.
                    maxLength: 60
                    example: Narrative title
                  description:
                    type: string
                    description: A detailed description of the narrative.
                    maxLength: 524288
                    example: Narrative description
                  position:
                    type: integer
                    format: int64
                    description: 'The value that determines the order in which it is displayed in the index action. `position` must be a value between `1` and `2147483647`.

                      '
                    example: 1
                  created_at:
                    type: string
                    description: The timestamp identifying when the narrative was created.
                    example: '2019-02-09T13:17:26Z'
                    format: date-time
                  updated_at:
                    type: string
                    description: The timestamp identifying when the narrative was last updated.
                    example: '2019-02-09T13:17:26Z'
                    format: date-time
              relationships:
                type: object
                description: The relationships associated with the resource.
                required:
                - objective
                properties:
                  objective:
                    type: object
                    description: 'Each narrative has an associated objective. Objectives are the basis of a project or framework.

                      They are also the organizing containers for the work done in a project or framework.

                      '
                    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 objective.
                            example: '1'
                          type:
                            type: string
                            description: The classification of the object (`"objectives"`).
                            example: objectives
                  framework_origin:
                    type: object
                    description: 'In the Projects app, a project `narrative` can have a related counterpart in an associated framework. The `framework_origin` attribute allows you to associate an `narrative` in a project with its related counterpart in a framework.

                      '
                    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 parent control.
                            example: '1'
                          type:
                            type: string
                            description: The classification of the object (`"narratives"`).
                            example: narratives
        links:
          type: object
          required:
          - next
          - prev
          properties:
            next:
              type:
              - string
              - 'null'
              description: Next page url
              example: /api/resource?page[number]=Mg==
            prev:
              type:
              - string
              - 'null'
              description: Previous page url
              example: null
    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.
    CreateNarrativeRequest:
      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 type of narrative (`"narratives"`).
              example: narratives
            attributes:
              type: object
              description: The attributes associated with the resource.
              required:
              - title
              properties:
                title:
                  type: string
                  description: The title of the narrative.
                  maxLength: 60
                  example: Narrative title
                description:
                  type: string
                  description: A detailed description of the narrative.
                  maxLength: 524288
                  example: Narrative description
                position:
                  type: integer
                  format: int64
                  description: 'The value that determines the order in which it is displayed in the index action. `position` must be a value between `1` and `2147483647`.

                    '
                  example: 1
            relationships:
              type: object
              description: The attributes associated with the resource.
              properties:
                framework_origin:
                  type: object
                  description: 'In the Projects app, a project `narrative` can have a related counterpart in an associated framework. The `framework_origin` attribute allows you to associate an `narrative` in a project with its related counterpart in a framework.

                    '
                  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 parent control.
                          example: '1'
                        type:
                          type: string
                          description: The classification of the object (`"narratives"`).
                          example: narratives
  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.
    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.

                '
    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.
    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.

                '
    Forbidden:
      description: Forbidden.
    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.
    BadCredentials:
      description: Bad credentials.
  parameters:
    pageNumberEncodedParam:
      in: query
      name: page[number]
      description: The Base64-encoded page number of records to return.
      required: false
      schema:
        type: string
        example: Mg==
    narrativeSparseFieldsetParams:
      in: query
      name: fields[narratives]
      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: title,description,created_at,updated_at,objective,framework_origin
    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
    resourceIdParam:
      in: path
      name: id
      description: The ID of the requested resource.
      required: true
      schema:
        type: string
        example: 9999
    objectiveIdParam:
      in: path
      name: objective_id
      description: The ID of the objective.
      required: true
      schema:
        type: integer
        example: 1
    orgIdParam:
      in: path
      name: org_id
      description: The ID of the HighBond instance.
      required: true
      schema:
        type: string
        example: 1
  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