Charthop

Charthop comment API

The comment API from Charthop — 5 operation(s) for comment.

GitHub OpenAPI

Operations 7

POST /v1/org/{orgId}/comment Post a comment #
GET /v1/org/{orgId}/comment/comp-review/{compReviewId} Return comments on changes within a comp review, paginated #
GET /v1/org/{orgId}/comment/entity/{entityId} Return comments on a particular entity paginated #
GET /v1/org/{orgId}/comment/scenario/{scenarioId} Return comments on a scenario and the changes within, paginated #
GET /v1/org/{orgId}/comment/{commentId} Return a particular comment by id #
PATCH /v1/org/{orgId}/comment/{commentId} Update a comment #
DELETE /v1/org/{orgId}/comment/{commentId} Delete a comment #

Documentation

📖
Documentation
https://docs.charthop.com/developer-basics

Specifications

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

Other Resources

🔗
Swagger
https://api.charthop.com/swagger

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/charthop-comment-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

charthop-comment-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: REST API for ChartHop
  version: V1.0.0
  title: ChartHop access Comment API
  contact:
    name: ChartHop
    url: https://www.charthop.com
    email: support@charthop.com
servers:
- url: https://localhost
- url: http://localhost
tags:
- name: comment
paths:
  /v1/org/{orgId}/comment:
    post:
      tags:
      - comment
      summary: Post a comment
      operationId: createComment
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      responses:
        '201':
          description: comment created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Comment'
        '400':
          description: invalid data
        '401':
          description: not authorized
        '403':
          description: permission denied
        '404':
          description: org not found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateComment'
        description: Comment data to create
        required: true
  /v1/org/{orgId}/comment/comp-review/{compReviewId}:
    get:
      tags:
      - comment
      summary: Return comments on changes within a comp review, paginated
      operationId: findCompReviewComments
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: compReviewId
        in: path
        description: Comp review id
        required: true
        schema:
          type: string
      - name: approvalRequestId
        in: query
        description: Approval request id
        required: false
        schema:
          type: string
      - name: from
        in: query
        description: Comment id to start paginating from
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return
        required: false
        schema:
          type: integer
          format: int32
      - name: desc
        in: query
        description: Descending (default false)
        required: false
        schema:
          type: boolean
      - name: isPreview
        in: query
        description: Whether comments are viewed in preview mode, defaults false
        required: false
        schema:
          type: boolean
      - name: jobId
        in: query
        description: Optional preview user jobId
        required: false
        schema:
          type: string
      - name: returnAccess
        in: query
        description: 'Return access information -- pass a list of actions to check, for example: create,update,delete'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultsComment'
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
  /v1/org/{orgId}/comment/entity/{entityId}:
    get:
      tags:
      - comment
      summary: Return comments on a particular entity paginated
      operationId: findComments
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: entityId
        in: path
        description: Entity id
        required: true
        schema:
          type: string
      - name: from
        in: query
        description: Comment id to start paginating from
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return
        required: false
        schema:
          type: integer
          format: int32
      - name: desc
        in: query
        description: Descending (default false)
        required: false
        schema:
          type: boolean
      - name: returnAccess
        in: query
        description: 'Return access information -- pass a list of actions to check, for example: create,update,delete'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultsComment'
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
  /v1/org/{orgId}/comment/scenario/{scenarioId}:
    get:
      tags:
      - comment
      summary: Return comments on a scenario and the changes within, paginated
      operationId: findScenarioComments
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: scenarioId
        in: path
        description: Scenario id
        required: true
        schema:
          type: string
      - name: from
        in: query
        description: Comment id to start paginating from
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return
        required: false
        schema:
          type: integer
          format: int32
      - name: desc
        in: query
        description: Descending (default false)
        required: false
        schema:
          type: boolean
      - name: includeChangeComments
        in: query
        description: Whether to also include comments on changes within the scenario (default false)
        required: false
        schema:
          type: boolean
      - name: returnAccess
        in: query
        description: 'Return access information -- pass a list of actions to check, for example: create,update,delete'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultsComment'
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
  /v1/org/{orgId}/comment/{commentId}:
    get:
      tags:
      - comment
      summary: Return a particular comment by id
      operationId: getComment
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: commentId
        in: path
        description: Comment id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Comment'
        '400':
          description: bad request
        '404':
          description: not found
    patch:
      tags:
      - comment
      summary: Update a comment
      operationId: updateComment
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: commentId
        in: path
        description: Comment id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: comment updated
        '400':
          description: invalid data
        '401':
          description: not authorized
        '403':
          description: permission denied
        '404':
          description: not found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateComment'
        description: Comment data to update
        required: true
    delete:
      tags:
      - comment
      summary: Delete a comment
      operationId: deleteComment
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: commentId
        in: path
        description: Comment id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: comment deleted
        '400':
          description: invalid data
        '401':
          description: not authorized
        '403':
          description: permission denied
        '404':
          description: not found
components:
  schemas:
    Attribution:
      type: object
      properties:
        principalUserId:
          type: string
          example: 588f7ee98f138b19220041a7
        agentUserIds:
          type: array
          items:
            type: string
            example: 588f7ee98f138b19220041a7
        eventId:
          type: string
          example: 588f7ee98f138b19220041a7
        aiChatId:
          type: string
          example: 588f7ee98f138b19220041a7
        aiToolUseId:
          type: string
        channel:
          type: string
          enum:
          - WEB
          - MOBILE
          - SLACK
          - TEAMS
          - MCP
    Comment:
      type: object
      required:
      - id
      - orgId
      - entityId
      - entityType
      - content
      - createAt
      - createId
      properties:
        id:
          type: string
          description: globally unique id
          example: 588f7ee98f138b19220041a7
        orgId:
          type: string
          description: org id the comment belongs to
          example: 588f7ee98f138b19220041a7
        parentEntityId:
          type: string
          description: parent entity id that this comment belongs to, should be used with entityId
          example: 588f7ee98f138b19220041a7
        entityId:
          type: string
          description: entity the comment was posted on
          example: 588f7ee98f138b19220041a7
        entityType:
          type: string
          description: type of entity the comment was posted on
          enum:
          - CHANGE
          - ASSESSMENT
          - SCENARIO
          - FORM_RESPONSE
          - APPROVAL_APPROVE
          - APPROVAL_REJECT
          - APPROVAL_REASSIGN
          - APPROVAL_WITHDRAW
        commentAction:
          type: string
          description: action that happened together with the comment
          enum:
          - APPROVE
          - REJECT
          - REQUEST_CHANGES
        content:
          description: content of comment
          $ref: '#/components/schemas/Markup'
        createAt:
          type: string
          description: timestamp that the comment was posted
          example: '2017-01-24T13:57:52Z'
        createId:
          type: string
          description: user id who posted the comment
          example: 588f7ee98f138b19220041a7
        createBehalfId:
          type: string
          description: created on behalf of user id
          example: 588f7ee98f138b19220041a7
        createAttribution:
          $ref: '#/components/schemas/Attribution'
        updateAt:
          type: string
          description: timestamp that the comment was edited
          example: '2017-01-24T13:57:52Z'
        updateId:
          type: string
          description: user id who edited the comment
          example: 588f7ee98f138b19220041a7
        updateBehalfId:
          type: string
          description: last updated on behalf of user id
          example: 588f7ee98f138b19220041a7
        updateAttribution:
          $ref: '#/components/schemas/Attribution'
        deleteAt:
          type: string
          description: deleted timestamp
          example: '2017-01-24T13:57:52Z'
        deleteId:
          type: string
          description: user who deleted the comment
          example: 588f7ee98f138b19220041a7
        deleteBehalfId:
          type: string
          description: deleted on behalf of user id
          example: 588f7ee98f138b19220041a7
        deleteAttribution:
          $ref: '#/components/schemas/Attribution'
    CreateComment:
      type: object
      required:
      - entityId
      - entityType
      - content
      properties:
        parentEntityId:
          type: string
          description: parent entity id that this comment belongs to, should be used with entityId
          example: 588f7ee98f138b19220041a7
        entityId:
          type: string
          description: entity the comment was posted on
          example: 588f7ee98f138b19220041a7
        entityType:
          type: string
          description: type of entity the comment was posted on
          enum:
          - CHANGE
          - ASSESSMENT
          - SCENARIO
          - FORM_RESPONSE
          - APPROVAL_APPROVE
          - APPROVAL_REJECT
          - APPROVAL_REASSIGN
          - APPROVAL_WITHDRAW
        commentAction:
          type: string
          description: action that happened together with the comment
          enum:
          - APPROVE
          - REJECT
          - REQUEST_CHANGES
        content:
          description: content of comment
          $ref: '#/components/schemas/Markup'
    ResultsAccess:
      type: object
      required:
      - allowed
      properties:
        ids:
          type: array
          uniqueItems: true
          items:
            type: string
            example: 588f7ee98f138b19220041a7
        allowed:
          type: array
          uniqueItems: true
          items:
            $ref: '#/components/schemas/AccessAction'
    Markup:
      type: object
      required:
      - type
      - value
      properties:
        type:
          type: string
          description: Type of markup
          enum:
          - HTML
          - MARKDOWN
          - TEXT
        value:
          type: string
          description: Markup content in its source format
    AccessAction:
      type: object
      required:
      - action
      properties:
        action:
          type: string
        fields:
          type: array
          uniqueItems: true
          items:
            type: string
        types:
          type: array
          uniqueItems: true
          items:
            type: string
    UpdateComment:
      type: object
      properties:
        content:
          description: content of comment
          $ref: '#/components/schemas/Markup'
    ResultsComment:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Comment'
        next:
          type: string
        access:
          type: array
          items:
            $ref: '#/components/schemas/ResultsAccess'