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

Endpoints used to interact with Fieldguide Requests

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

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

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

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

11 operations 8 paths 17 schemas 7 GET1 PATCH3 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 requests API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer). By default, every request must be authenticated.

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 7 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

requests 11

Endpoints used to interact with Fieldguide Requests

GET
/v1/requests/{uuid}/controls
List Controls that belong to the specified Request
list_controls_by_request_v1 4 params → 200400401403404429
GET
/v1/engagements/{uuid}/requests
List Requests that belong to the specified Engagement
list_requests_by_engagement_v1 7 params → 200400401403404429
GET
/v1/sheet-rows/{uuid}/requests
List Requests that belong to the specified Sheet Row
list_requests_by_sheet_row_v1 4 params → 200400401403404429
GET
/v1/requests/{uuid}
Fetch the specified Request
get_request_v1 1 param → 200400401403404429
PATCH
/v1/requests/{uuid}
Update the specified Request
update_request_v1 1 param body → 200400401403404429
GET
/v1/requests/{uuid}/sheet-rows
List Sheet Rows that belong to the specified Request
list_sheet_rows_by_request_v1 4 params → 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
GET
/v1/requests/{uuid}/comments
Fetch the Comments for the specified Request
list_comments_by_request_v1 4 params → 200400401403404429
POST
/v1/requests/{uuid}/comments
Post a Comment on a Request
create_request_comment_v1 1 param body → 201400401403429
POST
/v1/requests/comments
Post Comments on multiple Requests
create_request_comments_v1 body → 201400401403429

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are RequestRead (13 properties), FileRead (8 properties), CommentRead (6 properties), ControlRead (4 properties). Each schema is shown below with its type and property counts.

ControlReadLinks
object
1 property 1 required
RequestUpdate
object
1 property
RequestCommentBulkCreate
object
1 property 1 required
HalLink
object
3 properties 2 required
FileRead
object
8 properties 8 required
SheetRowRead
object
3 properties 3 required
SheetReadLinks
object
1 property 1 required
RequestReadLinks
object
1 property 1 required
RequestStatus
string
The request's current status in the evidence-collection workflow.
CommentCreate
object
2 properties 1 required
RequestRead
object
13 properties 13 required
ControlRead
object
4 properties 4 required
FileCreate
object
1 property 1 required
CommentRead
object
6 properties 6 required
RequestCommentBulkCreateItem
object
3 properties 2 required
CommentReadLinks
object
1 property 1 required
FileUploadRead
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fieldguide-requests-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 files API
Fieldguide insights API
Fieldguide jobs API
Fieldguide milestones 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 requests 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.