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

Endpoints used to interact with Fieldguide Companies

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

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

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

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

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

Paths & Operations 6

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

companies 6

Endpoints used to interact with Fieldguide Companies

GET
/v1/companies
List available Companies
list_companies_v1 5 params → 200400401403429
POST
/v1/companies
Create a new Company
create_company_v1 body → 201400401403429
GET
/v1/companies/{uuid}
Fetch the specified Company
get_company_v1 1 param → 200400401403404429
PATCH
/v1/companies/{uuid}
Update the specified Company
update_company_v1 1 param body → 200400401403404429
GET
/v1/companies/{uuid}/engagements
Get engagements for a given company
list_engagements_by_company_v1 4 params → 200400401403429
GET
/v1/companies/{uuid}/users
List Users that belong to the specified Company
list_company_users_v1 5 params → 200401403404429

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are EngagementRead (13 properties), UserRead (8 properties), CompanyRead (6 properties), HalLink (3 properties). Each schema is shown below with its type and property counts.

UserRead
object
8 properties 8 required
EngagementReadLinks
object
1 property 1 required
EngagementStatus
string
The engagement's current lifecycle status.
CompanyUpdate
object
3 properties
HalLink
object
3 properties 2 required
CompanyType
string
Whether the company is a Firm (the audit provider) or a Client.
UserReadLinks
object
1 property 1 required
CompanyCreate
object
3 properties 2 required
CompanyReadLinks
object
1 property 1 required
EngagementRead
object
13 properties 12 required
CompanyRead
object
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fieldguide-companies-api-openapi.yml Raw ↑

Other APIs Fieldguide publishes across the network.

Fieldguide api API
Fieldguide comments API
Fieldguide controls API
Fieldguide engagements API
Fieldguide files 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 companies 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.