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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Fieldguide

Fieldguide engagements API

Endpoints used to interact with Fieldguide Engagements

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

18 operations 14 paths 30 schemas 1 DELETE12 GET2 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 engagements API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer). By default, every request must be authenticated.

Paths & Operations 18

Across 14 paths, the API surfaces 18 operations — 1 DELETE, 12 GET, 2 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

engagements 18

Endpoints used to interact with Fieldguide Engagements

GET
/v1/companies/{uuid}/engagements
Get engagements for a given company
list_engagements_by_company_v1 4 params → 200400401403429
GET
/v1/engagements
List available Engagements
list_engagements_v1 8 params → 200400401403429
GET
/v1/engagements/{uuid}
Fetch the specified Engagement
get_engagement_v1 1 param → 200400401403404429
PATCH
/v1/engagements/{uuid}
Update the specified Engagement
update_engagement_v1 1 param body → 200400401403404429
POST
/v1/engagements/from-template
Create a new Engagement from a template
create_engagement_from_template_v1 body → 202400401403429
POST
/v1/engagements/{uuid}/export
Export an Engagement binder
export_engagement_v1 1 param → 202400401403404429
GET
/v1/engagements/exports/{uuid}
Fetch a generated Engagement binder report
get_engagement_export_v1 1 param → 200400401403404429
GET
/v1/engagements/{uuid}/users
List the Engagement Team on an Engagement
list_engagement_users_v1 4 params → 200400401403404429
PATCH
/v1/engagements/{uuid}/users
Add Users to an Engagement Team
add_engagement_users_v1 1 param body → 204400401403404429
DELETE
/v1/engagements/{uuid}/users
Remove Users from an Engagement Team
remove_engagement_users_v1 1 param body → 204400401403404429
GET
/v1/engagements/{uuid}/requests
List Requests that belong to the specified Engagement
list_requests_by_engagement_v1 7 params → 200400401403404429
GET
/v1/engagements/{uuid}/sheets
List Sheets that belong to the specified Engagement
list_sheets_by_engagement_v1 4 params → 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/engagements/{engagement_uuid}/milestones
List Milestones that belong to the specified Engagement
list_milestones_by_engagement_v1 8 params → 200400401403404429

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are EngagementRead (13 properties), MilestoneRead (13 properties), RequestRead (13 properties), EngagementFileRead (11 properties). Each schema is shown below with its type and property counts.

EngagementExportRead
object
5 properties 5 required
EngagementFileRead
object
11 properties 11 required
EngagementUserDelete
object
1 property 1 required
HalLink
object
3 properties 2 required
RequestRead
object
13 properties 13 required
EngagementRead
object
13 properties 12 required
JobSubmittedReadLinks
object
1 property 1 required
EngagementsQueryStatusLabel
string
EngagementUserRead
object
5 properties 5 required
EngagementStatusLabel
string
The status of the Engagement
EngagementCreateFromTemplate
object
7 properties 3 required
TemplatesQuery
string
EngagementFolderReadLinks
object
1 property 1 required
EngagementUuidRead
object
1 property 1 required
JobSubmittedRead
object
2 properties 2 required
EngagementFileReadLinks
object
1 property 1 required
EngagementReadLinks
object
1 property 1 required
SheetReadLinks
object
1 property 1 required
RequestStatus
string
The request's current status in the evidence-collection workflow.
MilestoneRead
object
13 properties 13 required
EngagementUserCreate
object
1 property 1 required
EngagementUpdate
object
4 properties
MilestoneReadLinks
object
4 properties 4 required
EngagementStatus
string
The engagement's current lifecycle status.
SheetRead
object
4 properties 4 required
EngagementFolderRead
object
7 properties 7 required
RequestReadLinks
object
1 property 1 required
EngagementFileCreate
object
2 properties 1 required
MilestoneSortBy
string
MilestoneAssociatedEngagementStatus
string
An optional association to an Engagement lifecycle phase. It does not represent the Engagement's current status or determine Milestone completion.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fieldguide-engagements-api-openapi.yml Raw ↑

Other APIs Fieldguide publishes across the network.

Fieldguide api API
AE Profile APIs.io
Fieldguide comments API
AE Profile APIs.io
Fieldguide companies API
AE Profile APIs.io
Fieldguide controls API
AE Profile APIs.io
Fieldguide files API
AE Profile APIs.io
Fieldguide insights API
AE Profile APIs.io
Fieldguide jobs API
AE Profile APIs.io
Fieldguide milestones API
AE Profile APIs.io
Fieldguide requests API
AE Profile APIs.io
Fieldguide sheet-columns API
AE Profile APIs.io
Fieldguide sheet-rows API
AE Profile APIs.io
Fieldguide sheets API
AE Profile APIs.io
#Engagements
← Back to F APIs
API Details
ID
fieldguide:fieldguide-engagements-api
Base URL
https://api.fieldguide.io
Docs
https://www.fieldguide.io/developers
Provider
Fieldguide
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=fieldguide-engagements-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/fieldguide-engagements-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Fieldguide engagements 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.