Charthop group API
The group API from Charthop — 17 operation(s) for group.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/charthop-group-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: REST API for ChartHop
version: V1.0.0
title: ChartHop access Group API
contact:
name: ChartHop
url: https://www.charthop.com
email: support@charthop.com
servers:
- url: https://localhost
- url: http://localhost
tags:
- name: group
paths:
/v2/org/{orgId}/group:
get:
tags:
- group
summary: Find groups in the organization of a certain type
operationId: findGroups
parameters:
- name: orgId
in: path
description: Org identifier (either id or slug)
required: true
schema:
type: string
- name: type
in: query
description: Group type
required: false
schema:
type: string
- name: scenarioId
in: query
description: Scenario id to query
required: false
schema:
type: string
- name: date
in: query
description: Date to search as of
required: false
schema:
type: string
format: date
- name: from
in: query
description: Group 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: fields
in: query
description: Fields to retrieve, comma-separated
required: false
schema:
type: string
- name: jobFields
in: query
description: job fields to return, comma-separated
required: false
schema:
type: string
- name: timeFilter
in: query
description: 'Temporal filter for groups: CURRENT (default, groups existing on date), ARCHIVED (deleted groups), FUTURE (future-dated groups), ALL (all groups)'
required: false
schema:
type: string
enum:
- CURRENT
- ARCHIVED
- FUTURE
- ALL
- name: includeAll
in: query
description: 'Deprecated: use timeFilter=ALL instead. Include all groups, including deleted groups.'
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
- name: search
in: query
description: Search string to filter on code & name
required: false
schema:
type: string
- name: format
in: query
description: Data format to use; default is json, can also use json-extended or json-readable
required: false
schema:
type: string
- name: ids
in: query
description: Comma-separated list of group ids to look up
required: false
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ResultsData'
'202':
description: snapshot currently building
'400':
description: bad request
'401':
description: not authorized
'404':
description: not found
/v2/org/{orgId}/group/bulk-delete:
post:
tags:
- group
summary: Mark multiple groups as deleted
operationId: deleteGroups
parameters:
- name: orgId
in: path
description: Org identifier (either id or slug)
required: true
schema:
type: string
- name: scenarioId
in: query
description: Scenario id to update the group in
required: false
schema:
type: string
- name: date
in: query
description: Effective date of group deletion
required: false
schema:
type: string
format: date
responses:
'200':
description: ok
content:
application/json:
schema:
$ref: '#/components/schemas/Process'
'400':
description: bad request
'401':
description: not authorized
'404':
description: not found
requestBody:
content:
application/json:
schema:
type: array
uniqueItems: true
items:
type: string
example: 588f7ee98f138b19220041a7
description: Group ids of groups to bulk delete
required: true
/v2/org/{orgId}/group/count:
get:
tags:
- group
summary: Get organized group counts
operationId: countGroups
parameters:
- name: orgId
in: path
description: Org identifier (either id or slug)
required: true
schema:
type: string
- name: scenarioId
in: query
description: scenario id to query
required: false
schema:
type: string
- name: groupFilter
in: query
description: query string to filter group by
required: false
schema:
type: string
- name: groupType
in: query
description: groupType
required: false
schema:
type: string
- name: groupTypeId
in: query
description: groupTypeId
required: false
schema:
type: string
- name: date
in: query
description: date to count as of
required: false
schema:
type: string
format: date
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/GroupCount'
'400':
description: bad request
'401':
description: not authorized
'404':
description: not found
'501':
description: not implemented
/v2/org/{orgId}/group/graph:
get:
tags:
- group
summary: Find groups in the organization of a certain type
operationId: findGroupGraph
parameters:
- name: orgId
in: path
description: Org identifier (either id or slug)
required: true
schema:
type: string
- name: start
in: query
description: group id to use as the starting point
required: false
schema:
type: string
- name: depth
in: query
description: number of levels down
required: false
schema:
type: integer
format: int32
- name: groupApproxLimit
in: query
description: limit number of groups
required: false
schema:
type: integer
format: int32
- name: jobLimit
in: query
description: limit number of jobs
required: false
schema:
type: integer
format: int32
- name: scenarioId
in: query
description: scenario id to query
required: false
schema:
type: string
- name: jobFilter
in: query
description: query string to filter jobs by
required: false
schema:
type: string
- name: groupFilter
in: query
description: query string to filter group by
required: false
schema:
type: string
- name: date
in: query
description: date to search as of
required: false
schema:
type: string
format: date
- name: groupFields
in: query
description: group fields to return
required: false
schema:
type: string
- name: jobFields
in: query
description: job/person fields to return
required: false
schema:
type: string
- name: format
in: query
description: Data format to use; default is json, can also use json-extended or json-readable
required: false
schema:
type: string
- name: groupType
in: query
description: groupType
required: false
schema:
type: string
- name: groupTypeId
in: query
description: groupTypeId
required: false
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/GroupGraphResults'
'400':
description: bad request
'401':
description: not authorized
'404':
description: not found
'501':
description: not implemented
/v2/org/{orgId}/group/import:
post:
tags:
- group
summary: Import data from CSV file
operationId: importCsv
parameters:
- name: orgId
in: path
description: Org identifier (either id or slug)
required: true
schema:
type: string
- name: date
in: query
description: Date to update as of
required: false
schema:
type: string
format: date
- name: skipErrors
in: query
description: Whether to skip erroneous rows, or reject the entire upload if any are invalid (default)
required: false
schema:
type: boolean
responses:
'202':
description: start import process
content:
application/json:
schema:
$ref: '#/components/schemas/Process'
'400':
description: invalid manifest data
'401':
description: not authorized
'403':
description: permission denied
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
/v2/org/{orgId}/group/import/download-template:
get:
tags:
- group
summary: Download a CSV template for group import
operationId: downloadImportCsvTemplate
parameters:
- name: orgId
in: path
description: Org identifier (either id or slug)
required: true
schema:
type: string
responses:
'200':
description: success
'400':
description: bad request
'401':
description: not authorized
'403':
description: permission denied
/v2/org/{orgId}/group/undelete:
post:
tags:
- group
summary: Undelete groups
operationId: undeleteGroups
parameters:
- name: orgId
in: path
description: Org identifier (either id or slug)
required: true
schema:
type: string
- name: scenarioId
in: query
description: Scenario id to update the group in
required: false
schema:
type: string
responses:
'202':
description: snapshot currently building
'400':
description: bad request
'401':
description: not authorized
'404':
description: not found
'501':
description: not implemented
requestBody:
content:
application/json:
schema:
type: array
uniqueItems: true
items:
type: string
example: 588f7ee98f138b19220041a7
description: Group ids of groups to undelete
required: true
/v2/org/{orgId}/group/{groupId}:
get:
tags:
- group
summary: Return a particular group by id
operationId: getGroup
parameters:
- name: orgId
in: path
description: Org identifier (either id or slug)
required: true
schema:
type: string
- name: groupId
in: path
description: Group identifier (either id or slug)
required: true
schema:
type: string
- name: type
in: query
description: Group type
required: false
schema:
type: string
- name: scenarioId
in: query
description: Scenario id to query
required: false
schema:
type: string
- name: date
in: query
description: Date
required: false
schema:
type: string
format: date
- name: fields
in: query
description: Fields to retrieve, comma-separated
required: false
schema:
type: string
- name: jobFields
in: query
description: job fields to return, comma-separated
required: false
schema:
type: string
- name: format
in: query
description: Data format to use; default is json, can also use json-extended or json-readable
required: false
schema:
type: string
- name: limit
in: query
required: false
schema:
type: integer
format: int32
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
additionalProperties: {}
'400':
description: bad request
'404':
description: not found
delete:
tags:
- group
summary: Delete a group
operationId: deleteGroup
parameters:
- name: orgId
in: path
description: Org identifier (either id or slug)
required: true
schema:
type: string
- name: groupId
in: path
description: Group id
required: true
schema:
type: string
- name: scenarioId
in: query
description: Scenario id to update the group in
required: false
schema:
type: string
- name: date
in: query
description: Effective date of group deletion
required: false
schema:
type: string
format: date
responses:
'202':
description: snapshot currently building
'400':
description: bad request
'401':
description: not authorized
'404':
description: not found
'501':
description: not implemented
/v2/org/{orgId}/group/{groupId}/addmembers:
patch:
tags:
- group
summary: Add members to a grouip
operationId: addMembers
parameters:
- name: orgId
in: path
description: Org identifier (either id or slug)
required: true
schema:
type: string
- name: groupId
in: path
description: Group id
required: true
schema:
type: string
- name: scenarioId
in: query
description: Scenario id to update the group in
required: false
schema:
type: string
- name: date
in: query
description: Effective date of member additions
required: false
schema:
type: string
format: date
responses:
'204':
description: members 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/AddRmvGroupMemberRequest'
description: Members to add to the group
required: true
/v2/org/{orgId}/group/{groupId}/can-purge:
get:
tags:
- group
summary: Check whether a group is eligible to be deleted from history
operationId: canDeleteGroupFromHistory
parameters:
- name: orgId
in: path
description: Org identifier (either id or slug)
required: true
schema:
type: string
- name: groupId
in: path
description: Group id
required: true
schema:
type: string
responses:
'200':
description: eligibility computed
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteFromHistoryEligibility'
'401':
description: not authorized
'403':
description: permission denied
'404':
description: not found
/v2/org/{orgId}/group/{groupId}/combine:
post:
tags:
- group
summary: Combine two groups together, including updating the historical record so that the two groups were never different
operationId: combineGroups
parameters:
- name: orgId
in: path
description: Org identifier (either id or slug)
required: true
schema:
type: string
- name: groupId
in: path
description: Group id
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Process'
'400':
description: bad request
'404':
description: not found
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CombineGroupRequest'
required: true
/v2/org/{orgId}/group/{groupId}/history:
get:
tags:
- group
summary: Get the history of changes for each field on a group
operationId: getGroupHistory
parameters:
- name: orgId
in: path
description: Org identifier (either id or slug)
required: true
schema:
type: string
- name: groupId
in: path
description: Group id
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/GroupHistoryRecord'
'400':
description: bad request
'404':
description: not found
/v2/org/{orgId}/group/{groupId}/purge:
delete:
tags:
- group
summary: Permanently delete a group from history
operationId: deleteGroupFromHistory
parameters:
- name: orgId
in: path
description: Org identifier (either id or slug)
required: true
schema:
type: string
- name: groupId
in: path
description: Group id
required: true
schema:
type: string
responses:
'204':
description: deleted
'400':
description: guard failed (see errorCode in payload)
'401':
description: not authorized
'403':
description: permission denied
'404':
description: not found
/v2/org/{orgId}/group/{groupId}/removemembers:
patch:
tags:
- group
summary: Remove members from a grouip
operationId: removeMembers
parameters:
- name: orgId
in: path
description: Org identifier (either id or slug)
required: true
schema:
type: string
- name: groupId
in: path
description: Group id
required: true
schema:
type: string
- name: scenarioId
in: query
description: Scenario id to update the group in
required: false
schema:
type: string
- name: date
in: query
description: Effective date of member removals
required: false
schema:
type: string
format: date
responses:
'204':
description: members 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/AddRmvGroupMemberRequest'
description: Members to remove from the group
required: true
/v2/org/{orgId}/group/{groupId}/render:
get:
tags:
- group
summary: Render the group description, resolving Carrot template expressions to live data
operationId: renderGroupDescription
parameters:
- name: orgId
in: path
description: Org identifier (either id or slug)
required: true
schema:
type: string
- name: groupId
in: path
description: Group identifier (either id or slug)
required: true
schema:
type: string
- name: type
in: query
description: Group type
required: false
schema:
type: string
- name: date
in: query
description: Date
required: false
schema:
type: string
format: date
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/GroupDescriptionRender'
'400':
description: bad request
'404':
description: not found
/v2/org/{orgId}/group/{type}:
post:
tags:
- group
summary: Create a group
operationId: createGroup
parameters:
- name: orgId
in: path
description: Org identifier (either id or slug)
required: true
schema:
type: string
- name: type
in: path
description: Group type
required: true
schema:
type: string
- name: scenarioId
in: query
description: Scenario id to create the group in
required: false
schema:
type: string
- name: date
in: query
description: Effective date of group creation
required: false
schema:
type: string
format: date
responses:
'202':
description: snapshot currently building
'400':
description: bad request
'401':
description: not authorized
'404':
description: not found
'501':
description: not implemented
requestBody:
content:
application/json:
schema:
type: object
additionalProperties:
type: object
required: true
/v2/org/{orgId}/group/{type}/{groupId}:
patch:
tags:
- group
summary: Update a group
operationId: updateGroup
parameters:
- name: orgId
in: path
description: Org identifier (either id or slug)
required: true
schema:
type: string
- name: type
in: path
description: Group type
required: true
schema:
type: string
- name: groupId
in: path
description: Group id
required: true
schema:
type: string
- name: scenarioId
in: query
description: Scenario id to update the group in
required: false
schema:
type: string
- name: date
in: query
description: Effective date of group update
required: false
schema:
type: string
format: date
responses:
'202':
description: snapshot currently building
'400':
description: bad request
'401':
description: not authorized
'404':
description: not found
'501':
description: not implemented
requestBody:
content:
application/json:
schema:
type: object
additionalProperties:
type: object
required: true
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
LogData:
type: object
required:
- level
- at
- data
properties:
level:
type: string
enum:
- INFO
- WARN
- ERROR
at:
type: string
description: created timestamp
example: '2017-01-24T13:57:52Z'
message:
type: string
data:
type: object
additionalProperties:
type: object
GroupCount:
type: object
required:
- totalGroupCount
- relationshipGroupCount
- orphanedGroupCount
properties:
totalGroupCount:
type: integer
format: int32
description: total number of groups
relationshipGroupCount:
type: integer
format: int32
description: number of groups that are part of a larger group tree
orphanedGroupCount:
type: integer
format: int32
description: number of orphaned groups that do not belong to any group tree
GroupGraphCount:
type: object
required:
- jobCount
- personCount
- groupCountByGroupTypeId
- groupCount
properties:
jobCount:
type: integer
format: int32
description: number of jobs
personCount:
type: integer
format: int32
description: number of persons
groupCountByGroupTypeId:
type: object
description: number of groups by group type id
additionalProperties:
type: integer
format: int32
groupCount:
type: integer
format: int32
description: total number of groups
GroupParent:
type: object
required:
- id
- type
properties:
id:
type: string
description: globally unique id
example: 588f7ee98f138b19220041a7
type:
type: string
description: type of the parent
example: GROUP
enum:
- GROUP
- JOB
GroupHistoryRecord:
type: object
required:
- id
- name
- type
- history
properties:
id:
type: string
description: group ID
example: 588f7ee98f138b19220041a7
name:
type: string
description: group name
type:
description: group type
$ref: '#/components/schemas/GroupTypeRef'
history:
type: object
description: history of changes for each field
additionalProperties:
type: array
items:
$ref: '#/components/schemas/GroupHistoryValue'
GroupHistoryValue:
type: object
required:
- date
- userId
properties:
date:
type: string
format: date
description: date of value change
value:
type: object
description: value
userId:
type: string
description: user who changed the value
example: 588f7ee98f138b19220041a7
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'
CombineGroupRequest:
type: object
required:
- fromGroupId
properties:
fromGroupId:
type: string
description: combine from group id
example: 588f7ee98f138b19220041a7
AddRmvGroupMemberRequest:
type: object
required:
- jobIds
properties:
jobIds:
type: array
description: job IDs to add to or remove from the group
uniqueItems: true
items:
type: string
example: 588f7ee98f138b19220041a7
GroupGraphResult:
type: object
required:
- group
- jobs
- groupPositions
- underCount
properties:
group:
type: object
description: group data
additionalProperties:
type: object
jobs:
type: array
description: job data
items:
type: object
additionalProperties:
type: object
groupPositions:
type: array
description: positions available within the group
items:
type: object
additionalProperties:
type: object
parent:
description: parent group or job
$ref: '#/components/schemas/GroupParent'
underCount:
description: number of groups/jobs "below" this group
$ref: '#/components/schemas/GroupGraphCount'
GroupTypeRef:
type: object
required:
- id
properties:
id:
type: string
example: 588f7ee98f138b19220041a7
name:
type: string
GroupDescriptionRender:
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
DeleteFromHistoryEligibility:
type: object
required:
- canDeleteFromHistory
- reasons
properties:
canDeleteFromHistory:
type: boolean
reasons:
type: array
items:
type: string
enum:
- NOT_FOUND
- HAS_JOBS
- HAS_CHILD_GROUPS
- REFERENCED_BY_GOAL
- REFERENCED_BY_BUDGET
- REFERENCED_BY_POLICY
- REFERENCED_BY_USER_ACCESS
- REFERENCED_BY_SCENARIO
- REFERENCED_BY_COMP_REVIEW
- REFERENCED_BY_TIMEOFF_POLICY
GroupGraphResults:
type: object
required:
- data
properties:
data:
type: array
items:
$ref: '#/components/schemas/GroupGraphResult'
nextId:
type: string
example: 588f7ee98f138b19220041a7
ResultsData:
type: object
required:
- data
properties:
data:
type: array
items:
type: object
additionalProperties:
type: object
next:
type: string
access:
type: array
items:
$ref: '#/components/schemas/ResultsAccess'
totalRow:
type: object
additionalProperties:
type: object
Process:
type: object
required:
- id
- orgId
- label
- type
- status
- runUserId
- createId
- createAt
- options
properties:
id:
type:
# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/charthop/refs/heads/main/openapi/charthop-group-api-openapi.yml