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

The field API from Charthop — 10 operation(s) for field.

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

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

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

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

13 operations 10 paths 17 schemas 2 DELETE5 GET2 PATCH4 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
Resource Areas
1

Paths & Operations 13

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

field 13
GET
/v1/org/{orgId}/field
Return all fields in the organization paginated
findFields 9 params → 200400401404
POST
/v1/org/{orgId}/field
Create a field
createField 3 params → 201400401403404
GET
/v1/org/{orgId}/field/built-in
Get built-in fields
getBuiltinFields 1 param → 200400401404
GET
/v1/org/{orgId}/field/category
Return uncategorized fields
getUncategorizedFields 1 param → 200400401404
GET
/v1/org/{orgId}/field/category/{categoryId}
Return fields in a particular category
getFieldsInCategory 2 params → 200400401404
DELETE
/v1/org/{orgId}/field/delete
Delete fields
deleteFields 2 params → 204400401403404
POST
/v1/org/{orgId}/field/remove-category
Remove field from all associated categories
removeFieldCategory 2 params → 204400401403404
POST
/v1/org/{orgId}/field/remove-overrides
Remove overrides from fields
removeFieldOverrides 2 params → 204400401403404
POST
/v1/org/{orgId}/field/status
Update status for existing fields
updateFieldStatus 2 params → 204400401403404
GET
/v1/org/{orgId}/field/{fieldId}
Return a particular field by id
getField 2 params → 200400404
PATCH
/v1/org/{orgId}/field/{fieldId}
Update an existing field
updateField 3 params → 204400401403404
DELETE
/v1/org/{orgId}/field/{fieldId}
Delete a field
deleteField 2 params → 204400401403404
PATCH
/v1/org/{orgId}/field/{fieldId}/dryrun
Perform a dry-run of an update to an existing field that will require migrations
updateFieldDryRun 3 params → 204400401403404

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Field (47 properties), PartialField (47 properties), CreateField (34 properties), UpdateField (31 properties). Each schema is shown below with its type and property counts.

TableRef
object
2 properties
FieldRemoveCategoryRequest
object
1 property 1 required
FieldRemoveOverrideRequest
object
1 property 1 required
EnumValue
object
9 properties 2 required
Field
object
47 properties 8 required
AutoIncFieldPart
object
3 properties 2 required
UpdateField
object
31 properties
CreateField
object
34 properties 7 required
DtValue
object
1 property
Translations
object
1 property 1 required
PartialField
object
47 properties
Attribution
object
6 properties
FieldOptions
object
15 properties
ResultsField
object
2 properties 1 required
FieldStatusUpdateRequest
object
3 properties 3 required
AutoIncFieldConfig
object
4 properties 4 required
ResultsPartialField
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-field-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