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

Netter file-folders API

The file-folders API from Netter — 10 operation(s) for file-folders.

Netter file-folders API is one of 44 APIs that Netter publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include file-folders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 13 operations across 10 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against the base URL https://api.netter.ai.

13 operations 10 paths 12 schemas 1 DELETE6 GET1 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.netter.ai
Resource Areas
1

Paths & Operations 13

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

file-folders 13
GET
/api/v1/file-folders
List File Folders
list_file_folders_api_v1_file_folders_get 2 params → 200422
POST
/api/v1/file-folders
Create File Folder Endpoint
create_file_folder_endpoint_api_v1_file_folders_post body → 201422
GET
/api/v1/file-folders/{folder_id}
Get File Folder
get_file_folder_api_v1_file_folders__folder_id__get 1 param → 200422
DELETE
/api/v1/file-folders/{folder_id}
Delete File Folder Endpoint
delete_file_folder_endpoint_api_v1_file_folders__folder_id__delete 1 param body → 204422
PATCH
/api/v1/file-folders/{folder_id}
Update File Folder
update_file_folder_api_v1_file_folders__folder_id__patch 1 param body → 200422
GET
/api/v1/file-folders/{folder_id}/breadcrumbs
Get Folder Breadcrumbs
get_folder_breadcrumbs_api_v1_file_folders__folder_id__breadcrumbs_get 1 param → 200422
GET
/api/v1/file-folders/{folder_id}/members
List Folder Members
list_folder_members_api_v1_file_folders__folder_id__members_get 1 param → 200422
GET
/api/v1/file-folders/{folder_id}/batches
List Folder Batches
list_folder_batches_api_v1_file_folders__folder_id__batches_get 1 param → 200422
POST
/api/v1/file-folders/{folder_id}/batches/{batch_key}:force-merge
Force Merge Batch
force_merge_batch_api_v1_file_folders__folder_id__batches__batch_key__force_merge_post 2 params → 200422
POST
/api/v1/file-folders/{folder_id}/batches/{batch_key}:discard
Discard Batch Endpoint
discard_batch_endpoint_api_v1_file_folders__folder_id__batches__batch_key__discard_post 2 params → 200422
GET
/api/v1/file-folders/{folder_id}/delete-preview
Preview Delete Folder
preview_delete_folder_api_v1_file_folders__folder_id__delete_preview_get 1 param → 200422
POST
/api/v1/file-folders/{folder_id}/group-key:test
Test Group Key
test_group_key_api_v1_file_folders__folder_id__group_key_test_post 1 param body → 200422
POST
/api/v1/file-folders/{folder_id}/move
Move File Folder Endpoint
move_file_folder_endpoint_api_v1_file_folders__folder_id__move_post 1 param body → 200422

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are FileFolderRead (15 properties), DatasetMemberRead (9 properties), FileFolderUpdate (8 properties), BatchSummary (5 properties). Each schema is shown below with its type and property counts.

DatasetMemberRead
object
One contributing file in a merge-enabled folder's collection dataset.
9 properties 4 required
BatchSummary
object
One batch group (by batchkey) in a folder's ingestion pipeline, with its read-time computed lifecycle status.
5 properties 5 required
ValidationError
object
5 properties 3 required
FileFolderMove
object
POST /file-folders/{id}/move payload.
1 property
FileFolderUpdate
object
PATCH payload — every field is optional so the same endpoint covers rename and merge toggle (mutually exclusive at most use sites; a single request that sets b…
8 properties
FileFolderBreadcrumb
object
One node on the breadcrumb path returned by the explorer endpoint.
2 properties 2 required
HTTPValidationError
object
1 property
FileFolderCreate
object
2 properties 1 required
FileFolderRead
object
15 properties 5 required
GroupKeyTestRequest
object
POST /file-folders/{id}/group-key:test payload — a candidate batchkeypattern regex to dry-run (not yet saved).
1 property 1 required
FileFolderDeletePreview
object
Cascade-delete preview returned by GET /file-folders/{id}/delete-preview.
3 properties 3 required
FileFolderDelete
object
DELETE /file-folders/{id} payload — the type-to-confirm guard. The frontend renders "Type the folder name to confirm" and only sends confirmwithname once the t…
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netter-file-folders-api-openapi.yml Raw ↑

Other APIs Netter publishes across the network.

Netter actions API
Netter api-keys API
Netter app-chat API
Netter apps API
Netter apps-query API
Netter assistant API
Netter attributes API
Netter automations API
Netter chats API
Netter companies API
Netter dashboard-chat API
Netter dashboard-data API