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

Charthop preload API

The preload API from Charthop — 1 operation(s) for preload.

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

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

This API exposes 1 operation across 1 path, and defines 70 schemas. It is described by OpenAPI 2.0, at version V1.0.0.

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

1 operations 1 paths 70 schemas 1 GET

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
Resource Areas
1

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

preload 1
GET
/v1/org/{orgId}/preload
Return a set of pre-loaded data required by the web app
getPreloadData 1 param → 200400404

Schemas 70

The contract defines 70 schemas that model the data the API accepts and returns. The most detailed are OrgOptions (234 properties), Field (47 properties), Org (46 properties), Form (39 properties). Each schema is shown below with its type and property counts.

OrgAccess
object
11 properties 2 required
Address
object
9 properties 1 required
TargetedInstruction
object
2 properties 2 required
PolicyRuleTarget
object
4 properties
OrgConfig
object
26 properties 1 required
InternalOrgOptions
object
15 properties
ExchangeRate
object
6 properties 4 required
StartingSalaryConfig
object
5 properties 2 required
GrantAlias
object
3 properties 2 required
Customer
object
35 properties 3 required
LayoutRow
object
2 properties 2 required
Translations
object
1 property 1 required
FieldOptions
object
15 properties
Role
object
14 properties 2 required
User
object
35 properties 2 required
FeatureAccessOption
object
4 properties 2 required
ProductItem
object
2 properties 2 required
AiAgentConfig
object
14 properties
CustomerDetails
object
2 properties 1 required
BundleInstallEntity
object
3 properties 3 required
TableRef
object
2 properties
PayInterval
object
6 properties 2 required
FormEditAccess
object
2 properties
OrgStockData
object
3 properties
Layout
object
1 property 1 required
Field
object
47 properties 8 required
FormSignatureConfig
object
6 properties 1 required
Geopoint
object
2 properties 2 required
FormBlock
object
8 properties 1 required
CompensationBandsConfig
object
21 properties 7 required
DtValue
object
1 property
LayoutButton
object
2 properties 2 required
Attribution
object
6 properties
CategorySort
object
15 properties 1 required
BundleInstall
object
1 property 1 required
DueDate
object
3 properties 3 required
BuiltInFieldConfig
object
3 properties 2 required
VariableComp
object
variable compensation Implementations: VariableCompPercent, VariableCompPercent
2 properties 2 required
AutoShare
object
2 properties 2 required
AutoIncFieldConfig
object
4 properties 4 required
Policy
object
14 properties 2 required
BuiltInCategoryMap
object
2 properties 2 required
EnumValue
object
9 properties 2 required
Money
object
3 properties 2 required
Block
object
12 properties
Comp
object
5 properties
GroupPosition
object
4 properties 2 required
PreloadResponse
object
20 properties 8 required
MessageChannelConfig
object
2 properties 2 required
MessagingConfig
object
3 properties
Form
object
39 properties 5 required
SmartCurrencyOption
object
2 properties 2 required
FormAiConfig
object
6 properties 2 required
Job
object
21 properties 5 required
LayoutColumn
object
1 property 1 required
UpcomingChange
object
6 properties 1 required
TrialProduct
object
3 properties 3 required
GroupType
object
30 properties 8 required
WebRegisteredCredential
object
5 properties 5 required
FormOptions
object
11 properties
Org
object
46 properties 4 required
OrgOptions
object
234 properties
UserEmailSetting
object
2 properties 2 required
AutoIncFieldPart
object
3 properties 2 required
Category
object
17 properties 2 required
ShareAccess
object
4 properties 1 required
PolicyRule
object
11 properties
Name
object
5 properties 1 required
OrgDomain
object
2 properties 2 required
JobRelationship
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-preload-api-openapi.yml Raw ↑

Other APIs Charthop publishes across the network.

Charthop access API
Charthop action API
Charthop ai API
Charthop ai-credit-limit API
Charthop ai-hint API
Charthop ai-prompt API
Charthop app API
Charthop appConfig API
Charthop approval API
Charthop approval-delegate API
Charthop approval-request API
Charthop assessment API