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

The org API from Charthop — 13 operation(s) for org.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

15 operations 13 paths 31 schemas 8 GET1 PATCH6 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 15

Across 13 paths, the API surfaces 15 operations — 8 GET, 1 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

org 15
GET
/org/{slug}
Return validation for a org by slug
getOrgBySlugNoAuth 1 param → 400404
GET
/v1/org
Return all visible orgs, paginated by name
findOrgs 8 params → 200400404
POST
/v1/org
Create a new org
createOrg 1 param → 201400401403
POST
/v1/org/app-install-code/validate
Validate authorization code
validateAppInstallAuthorizationCode 1 param → 200400401403404
GET
/v1/org/slug/{slug}
Return a particular org by slug
getOrgBySlug 1 param → 200400404
GET
/v1/org/{orgId}
Return a particular org by id
getOrg 1 param → 200400404
PATCH
/v1/org/{orgId}
Update an existing org
updateOrg 2 params → 204400401403404
GET
/v1/org/{orgId}/access
Return information on current user's access
getUserAccess 1 param → 200
POST
/v1/org/{orgId}/agreement
Consent on Terms of Service agreement
consentServiceAgreement 2 params → 400404
POST
/v1/org/{orgId}/copy-self-serve-demo-data
Copy self serve demo data into an org
copySelfServeDemoData 1 param → 200400401403
GET
/v1/org/{orgId}/data-user-person-count
Gets the count of joined users, invited users, and org members who are not yet invited
getOrgUserPersonCount 1 param → 200400404
GET
/v1/org/{orgId}/data-users-persons
Gets a list of org users (joined or invited) and org members (not yet invited)
getOrgUsersAndPeople 5 params → 200400404
POST
/v1/org/{orgId}/test-email
Send a test welcome email to oneself
sendTestEmail 2 params → 400404
GET
/v1/org/{orgId}/welcome-email
Gets the custom setting or default for the welcome email's subject, body, cta button label
getWelcomeEmailSettings 2 params → 200403500
POST
/v1/org/{org}/app-install-code
Retrieve an Oauth2 authorization code to install an app at this org
getAppInstallAuthorizationCode 1 param → 201400401403404

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are OrgOptions (234 properties), Org (46 properties), CreateOrg (29 properties), UpdateOrg (29 properties). Each schema is shown below with its type and property counts.

LogData
object
4 properties 3 required
Address
object
9 properties 1 required
InternalOrgOptions
object
15 properties
Translations
object
1 property 1 required
UserListRow
object
18 properties 3 required
UpdateOrg
object
29 properties
OrgUsersPersonsCountResponse
object
3 properties 3 required
AccessAction
object
3 properties 1 required
Process
object
29 properties 9 required
Layout
object
1 property 1 required
Geopoint
object
2 properties 2 required
LayoutButton
object
2 properties 2 required
Attribution
object
6 properties
OrgUsersPersonsResponse
object
2 properties 1 required
ResultsAccess
object
2 properties 1 required
AgreementRequest
object
2 properties 2 required
ResultsOrg
object
2 properties 1 required
AppInstallCodeValidateResponse
object
3 properties 1 required
Block
object
12 properties
TestEmailRequest
object
3 properties 3 required
MessageChannelConfig
object
2 properties 2 required
AccessTokenResponse
object
6 properties 2 required
LayoutColumn
object
1 property 1 required
AppInstallCodeValidateRequest
object
2 properties 2 required
CreateOrg
object
29 properties 9 required
Org
object
46 properties 4 required
OrgOptions
object
234 properties
WelcomeEmailSettings
object
4 properties 4 required
Name
object
5 properties 1 required
OrgDomain
object
2 properties 2 required
LayoutRow
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-org-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
#org
← Back to C APIs
API Details
ID
charthop:charthop-org-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