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

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

16 operations 13 paths 28 schemas 1 DELETE5 GET1 PATCH9 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 16

Across 13 paths, the API surfaces 16 operations — 1 DELETE, 5 GET, 1 PATCH, 9 POST. Each is listed below with its method, path, parameters, and response codes.

assessment 16
GET
/v1/org/{orgId}/assessment
Return all assessments in the organization paginated
findAssessments 6 params → 200400401404
POST
/v1/org/{orgId}/assessment
Create a assessment
createAssessment 2 params → 201400401403404
POST
/v1/org/{orgId}/assessment/bulk/delete
Delete a set of assessments
bulkDeleteAssessments 2 params → 200400401403404
POST
/v1/org/{orgId}/assessment/bulk/duplicate
Duplicate a set of assessments
bulkDuplicateAssessments 2 params → 200400401403404
POST
/v1/org/{orgId}/assessment/bulk/move
Update the types of a set of assessments
bulkChangeAssessmentTypes 2 params → 200400401403404
GET
/v1/org/{orgId}/assessment/{assessmentId}
Return a particular assessment by id
getAssessment 2 params → 200400404
PATCH
/v1/org/{orgId}/assessment/{assessmentId}
Update an existing assessment
updateAssessment 4 params → 400401403404
DELETE
/v1/org/{orgId}/assessment/{assessmentId}
Delete a assessment
deleteAssessment 2 params → 400401403404
POST
/v1/org/{orgId}/assessment/{assessmentId}/approve
Release all un-approved responses for a form of an assessment
approveFormResponses 4 params → 200400401403404
GET
/v1/org/{orgId}/assessment/{assessmentId}/calibration/person
Retrieve all persons who were targets of form submissions, retrieving both fields as well as question responses. This endpoint is typically used for calibrations.
findCalibrationPersons 8 params → 400401403404
POST
/v1/org/{orgId}/assessment/{assessmentId}/complete
Complete a assessment
completeAssessment 2 params → 201400401403404
POST
/v1/org/{orgId}/assessment/{assessmentId}/form/{formId}/expire
Expire all pending tasks for a form of an assessment
expireAssessmentFormTasks 3 params → 200400401403404
GET
/v1/org/{orgId}/assessment/{assessmentId}/forms-questions
Return an overview of the forms and questions used in the assessment. If the user has read access to the assessment, then the forms and questions are visible, even if they would not otherwise be visi…
getAssessmentFormsAndQuestions 2 params → 200400404
POST
/v1/org/{orgId}/assessment/{assessmentId}/reactivate
Reactivate a assessment
reactivateAssessment 2 params → 201400401403404
POST
/v1/org/{orgId}/assessment/{assessmentId}/release
Release all un-released responses for a form of an assessment
releaseFormResponses 4 params → 200400401403404
GET
/v1/org/{orgId}/assessment/{assessmentId}/task-summary
Return a summary of the tasks for a given assessment
getAssessmentTaskSummary 2 params → 200401

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Form (39 properties), Assessment (30 properties), Process (29 properties), Question (22 properties). Each schema is shown below with its type and property counts.

AssessmentTaskFormSummary
object
15 properties 15 required
LogData
object
4 properties 3 required
Translations
object
1 property 1 required
FieldOptions
object
15 properties
AssessmentFormsAndQuestions
object
2 properties 2 required
AccessAction
object
3 properties 1 required
Process
object
29 properties 9 required
FormBlock
object
8 properties 1 required
FormSignatureConfig
object
6 properties 1 required
Assessment
object
30 properties 5 required
Attribution
object
6 properties
DueDate
object
3 properties 3 required
CreateAssessment
object
16 properties 2 required
AutoShare
object
2 properties 2 required
BulkFormResponsesOptions
object
1 property
AssessmentTaskSummary
object
1 property 1 required
ResultsAccess
object
2 properties 1 required
EnumValue
object
9 properties 2 required
MessageChannelConfig
object
2 properties 2 required
Question
object
22 properties 3 required
Form
object
39 properties 5 required
UpdateAssessment
object
16 properties
FormAiConfig
object
6 properties 2 required
BulkChangeAssessmentTypesBody
object
2 properties 2 required
ResultsAssessment
object
3 properties 1 required
ShareAccess
object
4 properties 1 required
FormOptions
object
11 properties
FormEditAccess
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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