NEST VMS developer portal

Machine-readable resources for developers and AI agents integrating with NEST VMS.

What is available today

NEST VMS publishes a public, read-only content API at https://nestvms.com/api/v1. It exposes company identity, office locations, contact routing, site structure, platform modules and solution information as structured JSON. No authentication and no API key are required, and no customer or worker data is exposed through it.

This is the discovery surface, not the product API. The authenticated NEST VMS tenant API — job orders, workers, timesheets, compliance records and invoices — is provisioned per customer. Existing customers and integration partners can request access by emailing support@nestvms.com.

Everything here is designed to be consumed by an agent without scraping HTML: an OpenAPI 3.1 spec, JSON responses with a documented error envelope, markdown representations of every page, and an llms.txt that states when to use NEST VMS.

Resources

OpenAPI specification

OpenAPI 3.1 description of every public endpoint, with unique operation IDs, typed parameters and response schemas. Loadable directly as an LLM function-calling toolset.

/openapi.json

API documentation

Human-readable reference for the public content API: base URL, endpoints, response shapes, the JSON error format and example requests.

/docs

llms.txt

Agent guidance file describing what NEST VMS is, when an agent should reach for it, and where every machine-readable resource lives.

/llms.txt

Markdown content

Every page is available as markdown, either by appending .md to the path or by sending an Accept: text/markdown request header.

/about.md

Sitemap

Complete list of indexable URLs on nestvms.com.

/sitemap.xml

Health check

Liveness endpoint returning API status and version. Useful as a connectivity check before issuing other calls.

/api/v1/health

Endpoints

GET/api/v1/healthAPI status and version.
GET/api/v1/companyCompany identity, offices and departmental contact points.
GET/api/v1/pagesEvery public page with its URL, title, description and markdown URL.
GET/api/v1/platformPlatform modules and the three program models.
GET/api/v1/solutionsSolutions by audience, core capabilities and business outcomes.
GET/api/v1/contactMachine-readable contact routes for support, sales, vendors and billing.

Full request and response details are in the API documentation.

Quickstart

# Check the API is reachable
curl https://nestvms.com/api/v1/health

# Fetch company identity and contact routing
curl https://nestvms.com/api/v1/company

# Load the OpenAPI spec into a function-calling toolset
curl https://nestvms.com/openapi.json

# Read any page as markdown
curl -H "Accept: text/markdown" https://nestvms.com/platform