Charthop

Charthop content API

The content API from Charthop — 6 operation(s) for content.

GitHub OpenAPI

Operations 9

GET /v1/org/{orgId}/content Return all content in the organization paginated #
POST /v1/org/{orgId}/content Create a new piece of content #
PATCH /v1/org/{orgId}/content/homepage Update the homepage content #
GET /v1/org/{orgId}/content/homepage/render Render the contents of the homepage #
GET /v1/org/{orgId}/content/path/{path} Return a particular content by path #
GET /v1/org/{orgId}/content/path/{path}/render Return a particular content by path, and render its contents #
GET /v1/org/{orgId}/content/{contentId} Return a particular content by id #
PATCH /v1/org/{orgId}/content/{contentId} Update an existing piece of content #
DELETE /v1/org/{orgId}/content/{contentId} Delete a content #

Documentation

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/charthop/refs/heads/main/openapi/charthop-content-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-content-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-content-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: REST API for ChartHop
  version: V1.0.0
  title: ChartHop access Content API
  contact:
    name: ChartHop
    url: https://www.charthop.com
    email: support@charthop.com
servers:
- url: https://localhost
- url: http://localhost
tags:
- name: content
paths:
  /v1/org/{orgId}/content:
    get:
      tags:
      - content
      summary: Return all content in the organization paginated
      operationId: findContent
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: from
        in: query
        description: Content 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: returnAccess
        in: query
        description: 'Return access information -- pass a list of actions to check, for example: create,update,delete'
        required: false
        schema:
          type: string
      - name: includeBlocks
        in: query
        description: Include content blocks in results
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultsContent'
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
    post:
      tags:
      - content
      summary: Create a new piece of content
      operationId: createContent
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      responses:
        '201':
          description: content created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Content'
        '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/CreateContent'
        description: Content data to create
        required: true
  /v1/org/{orgId}/content/homepage:
    patch:
      tags:
      - content
      summary: Update the homepage content
      operationId: updateHomepage
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateContent'
        required: true
  /v1/org/{orgId}/content/homepage/render:
    get:
      tags:
      - content
      summary: Render the contents of the homepage
      operationId: renderHomepage
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HomepageContentRender'
  /v1/org/{orgId}/content/path/{path}:
    get:
      tags:
      - content
      summary: Return a particular content by path
      operationId: getContentByPath
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: path
        in: path
        description: Path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Content'
        '400':
          description: bad request
        '404':
          description: not found
  /v1/org/{orgId}/content/path/{path}/render:
    get:
      tags:
      - content
      summary: Return a particular content by path, and render its contents
      operationId: renderContentByPath
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: path
        in: path
        description: Path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentRender'
        '400':
          description: bad request
        '404':
          description: not found
  /v1/org/{orgId}/content/{contentId}:
    get:
      tags:
      - content
      summary: Return a particular content by id
      operationId: getContent
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: contentId
        in: path
        description: Content id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Content'
        '400':
          description: bad request
        '404':
          description: not found
    patch:
      tags:
      - content
      summary: Update an existing piece of content
      operationId: updateContent
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: contentId
        in: path
        description: Content id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: content 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/UpdateContent'
        description: Content data to update
        required: true
    delete:
      tags:
      - content
      summary: Delete a content
      operationId: deleteContent
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: contentId
        in: path
        description: Content id
        required: true
        schema:
          type: string
      - name: deleteChildren
        in: query
        description: Whether to delete the children resources
        required: false
        schema:
          type: boolean
      responses:
        '204':
          description: content 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
    ShareAccess:
      type: object
      required:
      - access
      properties:
        access:
          type: string
          description: access permission level
          enum:
          - NONE
          - LIMITED_READ
          - LIMITED_WRITE
          - STANDARD_READ
          - STANDARD_WRITE
          - COMPENSATION_READ
          - FULL_READ
          - COMP_PLANNING_PARTICIPANT
          - COMPENSATION_WRITE
          - WRITE
          - COMPENSATION_OWNER
          - OWNER
        userId:
          type: string
          description: user id
          example: 5887a7718f138b6a2a0041a7
        groupId:
          type: string
          description: group id
          example: 5887a7718f138b6a2a0041a7
        fields:
          type: string
          description: fields
          example: name,image,title
    ContentRender:
      type: object
      required:
      - title
      - blocks
      properties:
        title:
          type: string
        blocks:
          type: array
          items:
            $ref: '#/components/schemas/ContentBlock'
    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'
    CreateContent:
      type: object
      required:
      - title
      properties:
        parentContentId:
          type: string
          description: parent content id in the hierarchy
          example: 588f7ee98f138b19220041a7
        title:
          type: string
          description: title of the content page
          example: Benefits Policies
        titleTr:
          description: translations of the title
          $ref: '#/components/schemas/Translations'
        path:
          type: string
          description: full path to the content, if not set, defaults to an id/slug generated URL
          example: employee-info/benefits-policies
        blocks:
          type: array
          description: content blocks
          items:
            $ref: '#/components/schemas/ContentBlock'
        imagePath:
          type: string
          description: path to the image for the page
          example: path/to/image.jpg
          pattern: ^[a-zA-Z0-9._/-]+$
        emoji:
          type: string
          description: emoji, if an emoji is used to represent the page
          example: 💥
          minItems: 0
          maxItems: 64
        coverImagePath:
          type: string
          description: path to the cover image for the content page
          example: path/to/image.jpg
          pattern: ^[a-zA-Z0-9._/-]+$
        sensitive:
          type: string
          description: sensitivity level (ORG public, HIGHly sensitive, or PRIVATE)
          enum:
          - GLOBAL
          - ORG
          - SENSITIVE
          - PERSONAL
          - MANAGER
          - HIGH
          - PRIVATE
        shareAccess:
          type: array
          description: list of users and groups who have the content shared with them
          items:
            $ref: '#/components/schemas/ShareAccess'
        status:
          type: string
          description: current status of the content page
          enum:
          - DRAFT
          - ACTIVE
          - ARCHIVED
    Translations:
      type: object
      required:
      - values
      properties:
        values:
          type: object
          additionalProperties:
            type: string
    UpdateContent:
      type: object
      properties:
        parentContentId:
          type: string
          description: parent content id in the hierarchy
          example: 588f7ee98f138b19220041a7
        title:
          type: string
          description: title of the content page
          example: Benefits Policies
        titleTr:
          description: translations of the title
          $ref: '#/components/schemas/Translations'
        path:
          type: string
          description: full path to the content, if not set, defaults to an id/slug generated URL
          example: employee-info/benefits-policies
        blocks:
          type: array
          description: content blocks
          items:
            $ref: '#/components/schemas/ContentBlock'
        imagePath:
          type: string
          description: path to the image for the page
          example: path/to/image.jpg
          pattern: ^[a-zA-Z0-9._/-]+$
        emoji:
          type: string
          description: emoji, if an emoji is used to represent the page
          example: 💥
          minItems: 0
          maxItems: 64
        coverImagePath:
          type: string
          description: path to the cover image for the content page
          example: path/to/image.jpg
          pattern: ^[a-zA-Z0-9._/-]+$
        sensitive:
          type: string
          description: sensitivity level (ORG public, HIGHly sensitive, or PRIVATE)
          enum:
          - GLOBAL
          - ORG
          - SENSITIVE
          - PERSONAL
          - MANAGER
          - HIGH
          - PRIVATE
        shareAccess:
          type: array
          description: list of users and groups who have the content shared with them
          items:
            $ref: '#/components/schemas/ShareAccess'
        status:
          type: string
          description: current status of the content page
          enum:
          - DRAFT
          - ACTIVE
          - ARCHIVED
        sort:
          type: integer
          format: int32
          description: sort index within parent content
    ResultsContent:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Content'
        next:
          type: string
        access:
          type: array
          items:
            $ref: '#/components/schemas/ResultsAccess'
    Content:
      type: object
      required:
      - id
      - orgId
      - title
      - sensitive
      properties:
        id:
          type: string
          description: globally unique id
          example: 588f7ee98f138b19220041a7
        orgId:
          type: string
          description: parent organization id
          example: 588f7ee98f138b19220041a7
        parentContentId:
          type: string
          description: parent content id in the hierarchy
          example: 588f7ee98f138b19220041a7
        title:
          type: string
          description: title of the content page
          example: Benefits Policies
        titleTr:
          description: translations of the title
          $ref: '#/components/schemas/Translations'
        path:
          type: string
          description: full path to the content, if not set, defaults to an id/slug generated URL
          example: employee-info/benefits-policies
        blocks:
          type: array
          description: content blocks
          items:
            $ref: '#/components/schemas/ContentBlock'
        imagePath:
          type: string
          description: path to the image for the page
          example: path/to/image.jpg
          pattern: ^[a-zA-Z0-9._/-]+$
        emoji:
          type: string
          description: emoji, if an emoji is used to represent the page
          example: 💥
          minItems: 0
          maxItems: 64
        coverImagePath:
          type: string
          description: path to the cover image for the content page
          example: path/to/image.jpg
          pattern: ^[a-zA-Z0-9._/-]+$
        sensitive:
          type: string
          description: sensitivity level (ORG public, HIGHly sensitive, or PRIVATE)
          enum:
          - GLOBAL
          - ORG
          - SENSITIVE
          - PERSONAL
          - MANAGER
          - HIGH
          - PRIVATE
        shareAccess:
          type: array
          description: list of users and groups who have the content shared with them
          items:
            $ref: '#/components/schemas/ShareAccess'
        status:
          type: string
          description: current status of the content page
          enum:
          - DRAFT
          - ACTIVE
          - ARCHIVED
        sort:
          type: integer
          format: int32
          description: sort index within parent content
        createId:
          type: string
          description: created by user id
          example: 588f7ee98f138b19220041a7
        createBehalfId:
          type: string
          description: created on behalf of user id
          example: 588f7ee98f138b19220041a7
        createAttribution:
          $ref: '#/components/schemas/Attribution'
        createAt:
          type: string
          description: created timestamp
        updateId:
          type: string
          description: last updated by user id
          example: 588f7ee98f138b19220041a7
        updateBehalfId:
          type: string
          description: last updated on behalf of user id
          example: 588f7ee98f138b19220041a7
        updateAttribution:
          $ref: '#/components/schemas/Attribution'
        updateAt:
          type: string
          description: last updated timestamp
        deleteId:
          type: string
          description: deleted by user id
          example: 588f7ee98f138b19220041a7
        deleteBehalfId:
          type: string
          description: deleted on behalf of user id
          example: 588f7ee98f138b19220041a7
        deleteAttribution:
          $ref: '#/components/schemas/Attribution'
        deleteAt:
          type: string
          description: deleted timestamp
          example: '2017-01-24T13:57:52Z'
    HomepageContentRender:
      type: object
      required:
      - content
      properties:
        content:
          type: string
    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
    ContentBlock:
      type: object
      required:
      - content
      properties:
        content:
          type: string
        contentTr:
          $ref: '#/components/schemas/Translations'