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

The form API from Charthop — 15 operation(s) for form.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

19 operations 15 paths 38 schemas 2 DELETE6 GET1 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 19

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

form 19
GET
/v1/org/{orgId}/form
Return all forms in the organization paginated
findForms 5 params → 200400401404
POST
/v1/org/{orgId}/form
Create a form
createForm 2 params → 201400401403404
GET
/v1/org/{orgId}/form/available
Return all active forms applicable to a particular entity
getAvailableForms 3 params → 200400401404
DELETE
/v1/org/{orgId}/form/delete
Delete forms
deleteForms 2 params → 204400401403404
GET
/v1/org/{orgId}/form/person/{personId}
Return all active forms applicable to a particular person
findFormsForPerson 2 params → 200400401404
POST
/v1/org/{orgId}/form/status
Update status for existing forms
updateFormStatus 2 params → 200400401403404
GET
/v1/org/{orgId}/form/{formId}
Return a particular form by id
getForm 2 params → 200400404
PATCH
/v1/org/{orgId}/form/{formId}
Update an existing form
updateForm 3 params → 204400401403404
DELETE
/v1/org/{orgId}/form/{formId}
Delete a form
deleteForm 2 params → 204400401403404
POST
/v1/org/{orgId}/form/{formId}
Submit data from a form
legacySubmitForm 3 params → 204400401403404
POST
/v1/org/{orgId}/form/{formId}/collect
Collect data for an existing form, sending emails and chat notifications to people being requested
collectFormData 3 params → 201400401403404
GET
/v1/org/{orgId}/form/{formId}/draft
Get the current state of form draft data
getFormDraft 3 params → 200400401403404
POST
/v1/org/{orgId}/form/{formId}/duplicate
Duplicate a form
duplicateForm 3 params → 201400403404
POST
/v1/org/{orgId}/form/{formId}/preview-render
Render a preview of a form
renderPreviewForm 3 params → 200400401404
POST
/v1/org/{orgId}/form/{formId}/remind
Sends reminder for a form with existing tasks, sending emails/chat notifications to people being requested
remindFormData 3 params → 201400401403404
GET
/v1/org/{orgId}/form/{formId}/render
Render a form for display
renderForm 7 params → 200400401404
POST
/v1/org/{orgId}/form/{formId}/rerender/question/{updateQuestionId}
Re-render form blocks based on changes to the form values
rerenderForm 7 params → 200400401404
POST
/v1/org/{orgId}/form/{formId}/submit
Submit data from a form
submitForm 5 params → 204400401403404
POST
/v1/org/{orgId}/form/{formId}/submit/draft
Submit data from a form draft
submitFormDraft 5 params → 201400401403404

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are Form (39 properties), PartialForm (39 properties), Task (33 properties), Process (29 properties). Each schema is shown below with its type and property counts.

LogData
object
4 properties 3 required
FormPreviewRenderRequest
object
4 properties 2 required
PartialQuestion
object
22 properties
CreateForm
object
25 properties 3 required
Translations
object
1 property 1 required
FormRerender
object
2 properties 2 required
FieldOptions
object
15 properties
ResultsForm
object
3 properties 1 required
AccessAction
object
3 properties 1 required
Process
object
29 properties 9 required
FormRenderBlock
object
14 properties 2 required
FormStatusUpdateRequest
object
2 properties 2 required
FormBlock
object
8 properties 1 required
FormSignatureConfig
object
6 properties 1 required
UpdateForm
object
25 properties
Attribution
object
6 properties
DueDate
object
3 properties 3 required
AutoShare
object
2 properties 2 required
ResultsFormSummary
object
3 properties 1 required
ResultsAccess
object
2 properties 1 required
EnumValue
object
9 properties 2 required
Task
object
33 properties 6 required
MessageChannelConfig
object
2 properties 2 required
Form
object
39 properties 5 required
PartialFormDraft
object
15 properties
FormAiConfig
object
6 properties 2 required
FormCollectionResponse
object
2 properties 1 required
FormCollectRequest
object
7 properties 1 required
FormSubmitRequest
object
3 properties 2 required
FormRender
object
11 properties 7 required
ShareAccess
object
4 properties 1 required
PartialForm
object
39 properties
DuplicateFormOptions
object
2 properties 1 required
FormPreviewBlock
object
6 properties 1 required
FormSummary
object
4 properties 3 required
FormOptions
object
11 properties
FormEditAccess
object
2 properties
FormDraft
object
15 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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