How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Fieldguide files API

Endpoints used to interact with Fieldguide Files

Fieldguide files API is one of 15 APIs that Fieldguide publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 10 operations across 7 paths, and defines 10 schemas. It is described by OpenAPI 3.0.0, at version v1.

Requests are made against a single base URL, https://api.fieldguide.io.

10 operations 7 paths 10 schemas 1 DELETE7 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1
Base URL
https://api.fieldguide.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Fieldguide files API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer). By default, every request must be authenticated.

Paths & Operations 10

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

files 10

Endpoints used to interact with Fieldguide Files

DELETE
/v1/files/{uuid}
Delete the specified File
delete_file_v1 1 param → 204400401403404429
GET
/v1/files/{uuid}
Get details for a specific File
get_file_v1 1 param → 200400401403404429
GET
/v1/files/{uuid}/context
Get context for a specific File
get_file_context_v1 1 param → 200400401403404429
GET
/v1/engagements/{uuid}/folders
List Folders that belong to the specified Engagement
list_engagement_folders_v1 5 params → 200400401403404429
GET
/v1/engagements/{engagement_uuid}/folders/{folder_uuid}
Fetch a Folder by Engagement and Folder UUIDs
get_engagement_folder_v1 2 params → 200400401403404429
GET
/v1/engagements/{engagement_uuid}/files/{file_uuid}
Fetch a File by Engagement and File UUIDs
get_engagement_file_v1 2 params → 200400401403404429
GET
/v1/engagements/{uuid}/files
List Files that belong to the specified Engagement
list_engagement_files_v1 5 params → 200400401403404429
POST
/v1/engagements/{uuid}/files
Upload a File to the specified Engagement
upload_engagement_file_v1 1 param body → 200400401403404429
GET
/v1/requests/{uuid}/files
Fetch the Files for the specified Request
list_request_files_v1 4 params → 200401403404
POST
/v1/requests/{uuid}/files
Upload a File to the specified Request
upload_request_file_v1 1 param body → 200400401403404429

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are EngagementFileRead (11 properties), FileRead (8 properties), EngagementFolderRead (7 properties), HalLink (3 properties). Each schema is shown below with its type and property counts.

EngagementFileReadLinks
object
1 property 1 required
EngagementFolderRead
object
7 properties 7 required
EngagementFileRead
object
11 properties 11 required
HalLink
object
3 properties 2 required
FileRead
object
8 properties 8 required
FileCreate
object
1 property 1 required
FileContextRead
object
2 properties 2 required
EngagementFileCreate
object
2 properties 1 required
EngagementFolderReadLinks
object
1 property 1 required
FileUploadRead
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fieldguide-files-api-openapi.yml Raw ↑

Other APIs Fieldguide publishes across the network.

Fieldguide api API
Fieldguide comments API
Fieldguide companies API
Fieldguide controls API
Fieldguide engagements API
Fieldguide insights API
Fieldguide jobs API
Fieldguide milestones API
Fieldguide requests API
Fieldguide sheet-columns API
Fieldguide sheet-rows API
Fieldguide sheets API
Where this information came from

This is an independent, third-party profile of Fieldguide files API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.