Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Charthop

Charthop group API

The group API from Charthop — 17 operation(s) for group.

Documentation Provider Profile APIs.io OpenAPI GitHub

Charthop group API is one of 87 APIs that Charthop publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include group. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 18 operations across 17 paths, and defines 18 schemas. It is described by OpenAPI 2.0, at version V1.0.0.

Requests are made against the base URL https://api.charthop.com.

18 operations 17 paths 18 schemas 2 DELETE8 GET3 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
V1.0.0
Base URL
https://api.charthop.com
Contact
ChartHop
Resource Areas
1

Paths & Operations 18

Across 17 paths, the API surfaces 18 operations — 2 DELETE, 8 GET, 3 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

group 18
GET
/v2/org/{orgId}/group
Find groups in the organization of a certain type
findGroups 14 params → 200202400401404
POST
/v2/org/{orgId}/group/bulk-delete
Mark multiple groups as deleted
deleteGroups 4 params → 200400401404
GET
/v2/org/{orgId}/group/count
Get organized group counts
countGroups 6 params → 200400401404501
GET
/v2/org/{orgId}/group/graph
Find groups in the organization of a certain type
findGroupGraph 14 params → 200400401404501
POST
/v2/org/{orgId}/group/import
Import data from CSV file
importCsv 4 params → 202400401403
GET
/v2/org/{orgId}/group/import/download-template
Download a CSV template for group import
downloadImportCsvTemplate 1 param → 200400401403
POST
/v2/org/{orgId}/group/undelete
Undelete groups
undeleteGroups 3 params → 202400401404501
GET
/v2/org/{orgId}/group/{groupId}
Return a particular group by id
getGroup 9 params → 200400404
DELETE
/v2/org/{orgId}/group/{groupId}
Delete a group
deleteGroup 4 params → 202400401404501
PATCH
/v2/org/{orgId}/group/{groupId}/addmembers
Add members to a grouip
addMembers 5 params → 204400401403404
GET
/v2/org/{orgId}/group/{groupId}/can-purge
Check whether a group is eligible to be deleted from history
canDeleteGroupFromHistory 2 params → 200401403404
POST
/v2/org/{orgId}/group/{groupId}/combine
Combine two groups together, including updating the historical record so that the two groups were never different
combineGroups 3 params → 200400404
GET
/v2/org/{orgId}/group/{groupId}/history
Get the history of changes for each field on a group
getGroupHistory 2 params → 200400404
DELETE
/v2/org/{orgId}/group/{groupId}/purge
Permanently delete a group from history
deleteGroupFromHistory 2 params → 204400401403404
PATCH
/v2/org/{orgId}/group/{groupId}/removemembers
Remove members from a grouip
removeMembers 5 params → 204400401403404
GET
/v2/org/{orgId}/group/{groupId}/render
Render the group description, resolving Carrot template expressions to live data
renderGroupDescription 4 params → 200400404
POST
/v2/org/{orgId}/group/{type}
Create a group
createGroup 5 params → 202400401404501
PATCH
/v2/org/{orgId}/group/{type}/{groupId}
Update a group
updateGroup 6 params → 202400401404501

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are Process (29 properties), Attribution (6 properties), GroupGraphResult (5 properties), LogData (4 properties). Each schema is shown below with its type and property counts.

AccessAction
object
3 properties 1 required
GroupGraphCount
object
4 properties 4 required
GroupParent
object
2 properties 2 required
ResultsAccess
object
2 properties 1 required
AddRmvGroupMemberRequest
object
1 property 1 required
GroupGraphResult
object
5 properties 4 required
GroupHistoryValue
object
3 properties 2 required
Process
object
29 properties 9 required
LogData
object
4 properties 3 required
GroupTypeRef
object
2 properties 1 required
CombineGroupRequest
object
1 property 1 required
Attribution
object
6 properties
GroupDescriptionRender
object
1 property 1 required
GroupHistoryRecord
object
4 properties 4 required
GroupCount
object
3 properties 3 required
DeleteFromHistoryEligibility
object
2 properties 2 required
GroupGraphResults
object
2 properties 1 required
ResultsData
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-group-api-openapi.yml Raw ↑

Other APIs Charthop publishes across the network.

Charthop access API
AE Profile APIs.io
Charthop action API
AE Profile APIs.io
Charthop ai API
AE Profile APIs.io
Charthop ai-credit-limit API
AE Profile APIs.io
Charthop ai-hint API
AE Profile APIs.io
Charthop ai-prompt API
AE Profile APIs.io
Charthop app API
AE Profile APIs.io
Charthop appConfig API
AE Profile APIs.io
Charthop approval API
AE Profile APIs.io
Charthop approval-delegate API
AE Profile APIs.io
Charthop approval-request API
AE Profile APIs.io
Charthop assessment API
AE Profile APIs.io
#group
← Back to C APIs
API Details
ID
charthop:charthop-group-api
Base URL
https://api.charthop.com
Docs
https://docs.charthop.com/charthop-for-developers
Provider
Charthop
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network