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 app API

The app API from Charthop — 18 operation(s) for app.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

26 operations 18 paths 116 schemas 3 DELETE11 GET2 PATCH10 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 26

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

app 26
GET
/v1/app
Return all publicly visible global apps
findGlobalApps 3 params → 200400404
POST
/v1/app
Create a new app
createApp 1 param → 201400401403
GET
/v1/app/install/{appId}
Get all active installs of this app
getActiveAppInstalls 4 params → 200
GET
/v1/app/name/{appName}
Return a particular app by name
getAppByName 1 param → 200400404
POST
/v1/app/notify
Send an email notification to the configured notify users, on behalf of an app
sendNotification 1 param → 204400401403404
GET
/v1/app/org/{orgId}
Return all active apps available for a particular org
findApps 6 params → 200400404
GET
/v1/app/org/{orgId}/install
Find installed app users
findInstalledApps 7 params → 200400404
POST
/v1/app/org/{orgId}/install
Install an app for a particular org
installApp 2 params → 201400401403
GET
/v1/app/org/{orgId}/install/name/{appName}
Get an installed app by name
getInstalledAppByName 3 params → 200400401403404
POST
/v1/app/org/{orgId}/install/validate
Validate the installation of an app for a particular org
validateInstallApp 2 params → 201400401403
GET
/v1/app/org/{orgId}/install/{appUserId}
Get an installed app
getInstalledApp 2 params → 200400401403404
PATCH
/v1/app/org/{orgId}/install/{appUserId}
Update the settings of an installed app
updateInstalledApp 4 params → 204400401403404
DELETE
/v1/app/org/{orgId}/install/{appUserId}
Uninstall an app
uninstallApp 3 params → 400401403404
POST
/v1/app/org/{orgId}/install/{appUserId}/api-operation/{operation}
Execute one configured external API operation against the live external service (the app config 'Test' action). Requires readExternal for a read-only operation, writeExternal otherwise; a non-read-on…
testApiOperation 7 params → 200400401403404
POST
/v1/app/org/{orgId}/install/{appUserId}/code
Retrieve an Oauth2 authorization code for this app, which can be exchanged for an access token
getAuthorizationCode 3 params → 201400401403404
GET
/v1/app/org/{orgId}/install/{appUserId}/connections
List an installed agent's active MCP connections (one per connected user token)
listMcpConnections 2 params → 200403404
DELETE
/v1/app/org/{orgId}/install/{appUserId}/connections
Revoke MCP connections for an installed agent
revokeMcpConnections 3 params → 204403404
POST
/v1/app/org/{orgId}/install/{appUserId}/disable-sync
Disable automatic sync for an app installation whose credentials are failing
disableSync 3 params → 200400401403404
GET
/v1/app/org/{orgId}/install/{appUserId}/installdata/{installDataName}
Retrieve the current token for this app
getAppInstallData 3 params → 400401403404
POST
/v1/app/org/{orgId}/install/{appUserId}/oauth-token/refresh
Force-refresh the vendor OAuth token for an app installation
refreshOauthToken 3 params → 200400401403404
POST
/v1/app/org/{orgId}/install/{appUserId}/run
Run an installed app
runInstalledApp 3 params → 200400401403404
GET
/v1/app/org/{orgId}/install/{appUserId}/token
Retrieve the current token for this app
getAccessToken 2 params → 200400401403404
POST
/v1/app/org/{orgId}/install/{appUserId}/token
Generate or regenerate a long-lived access token for the app
generateAccessToken 3 params → 201400401403404
GET
/v1/app/{appId}
Return a particular app by id
getApp 1 param → 200400404
PATCH
/v1/app/{appId}
Update an existing app
updateApp 2 params → 204400401403404
DELETE
/v1/app/{appId}
Delete an app
deleteApp 1 param → 400401403404

Schemas 116

The contract defines 116 schemas that model the data the API accepts and returns. The most detailed are PartialField (47 properties), App (46 properties), TimeOffPolicy (43 properties), PartialForm (39 properties). Each schema is shown below with its type and property counts.

ActionStep
object
20 properties 1 required
PaginationConfig
object
11 properties 1 required
GroupPositionAssignments
object
1 property 1 required
BundleReport
object
2 properties 1 required
LogData
object
4 properties 3 required
HiringTeamAssignment
object
2 properties 1 required
AccrualConfig
object
6 properties 2 required
Calendar
object
24 properties 7 required
User
object
35 properties 2 required
ReportFilter
object
2 properties 2 required
PolicyEvent
object
5 properties 2 required
PartialField
object
47 properties
TimeOffPolicy
object
43 properties 5 required
PolicyAction
object
2 properties 1 required
BundleInstall
object
1 property 1 required
BundleCalendar
object
2 properties 1 required
CalendarEntry
object
22 properties 5 required
AutoIncFieldConfig
object
4 properties 4 required
UpdateApp
object
32 properties
EntityRef
object
2 properties 1 required
ResultsAccess
object
2 properties 1 required
EnumValue
object
9 properties 2 required
ResultsApp
object
3 properties 1 required
GroupRef
object
3 properties 1 required
MessagingConfig
object
3 properties
LayoutColumn
object
1 property 1 required
LabelOverride
object
4 properties 1 required
Category
object
17 properties 2 required
ScopeRequest
object
1 property 1 required
Content
object
26 properties 4 required
Name
object
5 properties 1 required
FormSignatureConfig
object
6 properties 1 required
OauthRefreshResponse
object
1 property 1 required
PartialProfileTab
object
22 properties
PartialReport
object
21 properties
OpeningConfig
object
6 properties 1 required
OutboundFieldMapper
object
7 properties 1 required
App
object
46 properties 7 required
AccessAction
object
3 properties 1 required
Template
object
26 properties 5 required
Bundle
object
13 properties
AutoShare
object
2 properties 2 required
ExternalApiExecutionResult
object
6 properties 2 required
ApiBodyProperty
object
8 properties 4 required
Block
object
12 properties
TextRef
object
2 properties
FormAiConfig
object
6 properties 2 required
WebRegisteredCredential
object
5 properties 5 required
TranscriptAppConfig
object
4 properties 2 required
UserEmailSetting
object
2 properties 2 required
CreateUser
object
14 properties 1 required
DisableSyncResponse
object
1 property 1 required
PullAppConfig
object
1 property
BundleInstallValidate
object
3 properties 1 required
PolicyRule
object
11 properties
LayoutRow
object
2 properties 2 required
OauthRefreshRequest
object
2 properties
SuccessPredicate
object
3 properties 2 required
AppSecrets
object
3 properties
Translations
object
1 property 1 required
ResultsUser
object
3 properties 1 required
DisableSyncRequest
object
1 property
FieldOptions
object
15 properties
ReportSeriesQuery
object
4 properties 3 required
PartialGroup
object
34 properties
AiAgentConfig
object
14 properties
PartialReportChart
object
22 properties
ExternalApiRequestLog
object
7 properties 5 required
AppConfigField
object
9 properties 3 required
TableRef
object
2 properties
Process
object
29 properties 9 required
HmacConfig
object
4 properties
RevokeMcpConnectionsRequest
object
1 property
ForEach
object
2 properties
Layout
object
1 property 1 required
Geopoint
object
2 properties 2 required
LayoutButton
object
2 properties 2 required
Attribution
object
6 properties
ApiParameter
object
8 properties 5 required
MessageChannelConfig
object
2 properties 2 required
Question
object
22 properties 3 required
ApiRequestBody
object
2 properties 2 required
ReportQuery
object
8 properties 1 required
ApiOperation
object
12 properties 5 required
PartialTaskConfig
object
24 properties
GroupByConfig
object
9 properties
ShareAccess
object
4 properties 1 required
FormEditAccess
object
2 properties
OrgAccess
object
11 properties 2 required
Address
object
9 properties 1 required
ApiEntity
object
7 properties 2 required
TargetedInstruction
object
2 properties 2 required
PolicyRuleTarget
object
4 properties
GroupTypeRef
object
2 properties 1 required
ExternalApiAuthConfig
object
15 properties 1 required
ContentBlock
object
2 properties 1 required
BundleInstallEntity
object
3 properties 3 required
AtsAppConfig
object
14 properties 3 required
JwtConfig
object
4 properties
FieldMapper
object
18 properties 3 required
FormBlock
object
8 properties 1 required
NotifyRequest
object
5 properties 1 required
UpdateUser
object
13 properties
DueDate
object
3 properties 3 required
Money
object
3 properties 2 required
ApiOperationCall
object
3 properties 1 required
SignaturePlacement
object
8 properties 4 required
AccessTokenResponse
object
6 properties 2 required
CreateApp
object
33 properties 7 required
WebhookConfig
object
6 properties 1 required
PartialAction
object
25 properties
AutoIncFieldPart
object
3 properties 2 required
ExternalApiConfig
object
11 properties 1 required
PartialForm
object
39 properties
RateLimitConfig
object
5 properties
FormOptions
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-app-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 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
Charthop band API
AE Profile APIs.io
#app
← Back to C APIs
API Details
ID
charthop:charthop-app-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