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

Endpoints used to interact with Fieldguide Users

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

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

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

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

7 operations 5 paths 6 schemas 1 DELETE5 GET1 PATCH

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 users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer). By default, every request must be authenticated.

Paths & Operations 7

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

users 7

Endpoints used to interact with Fieldguide Users

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/users
List available Users
list_users_v1 4 params → 200400401403429
GET
/v1/users/me
Fetch the authenticated User
get_current_user_v1 → 200401429
GET
/v1/users/{uuid}
Fetch the specified User
get_user_v1 1 param → 200400401403404429
GET
/v1/companies/{uuid}/users
List Users that belong to the specified Company
list_company_users_v1 5 params → 200401403404429

Schemas 6

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

UserRead
object
8 properties 8 required
EngagementUserRead
object
5 properties 5 required
HalLink
object
3 properties 2 required
UserReadLinks
object
1 property 1 required
EngagementUserDelete
object
1 property 1 required
EngagementUserCreate
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fieldguide-users-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 requests API
Fieldguide sheet-columns API
Fieldguide sheet-rows API
Where this information came from

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