developer portal

Francione Design Group API

Public read-only REST API and developer tools for agents, LLMs, and applications requiring structured data about our Jersey Shore hardscaping services, project portfolio, and service areas.

Quick Start

Base URL: https://www.francionedesigngroup.com/api/v1

All public read endpoints require no authentication. Successful responses return a standard JSON object with a top-level data property. Standard RFC RateLimit headers and RFC 9457 error details are provided on all responses.

OpenAPI JSON OpenAPI YAML llms.txt llms-full.txt

CLI Tool (Zero Install)

Query our public API directly from terminal or agent execution environments using our lightweight CLI:

# Query services
npx fdg services

# Query contact details with raw JSON output
npx fdg contact --json

# Query service area locations in Monmouth County
npx fdg locations --county "Monmouth County"

Example REST Requests

# Get company credentials and license info
curl -s https://www.francionedesigngroup.com/api/v1/contact | jq .data

# List all services
curl -s https://www.francionedesigngroup.com/api/v1/services | jq .data

# Get service details for Hardscaping & Outdoor Living
curl -s https://www.francionedesigngroup.com/api/v1/services/hardscaping-outdoor-living | jq .data

Endpoints Reference

GET/api/v1/services

listServices

List all hardscaping and landscape design services.

GET/api/v1/services/{slug}

getServiceBySlug

Get one service by slug (e.g. hardscaping-outdoor-living, landscape-design).

GET/api/v1/projects

listProjects

List completed luxury residential hardscaping portfolio projects.

GET/api/v1/projects/{slug}

getProjectBySlug

Get detailed project case study, about sections, solutions, and imagery.

GET/api/v1/locations

listLocations

List Jersey Shore service area towns. Supports optional ?county= filter.

GET/api/v1/locations/{slug}

getLocationBySlug

Get hardscaping and landscape design information for a specific town.

GET/api/v1/contact

getContactInfo

Business phone, email, NJ license number, hours, and inquiry URLs.

Rate Limiting Standards

All REST API endpoints are rate-limited to 120 requests per minute per client IP. Responses include standard IETF RFC RateLimit headers so agents can self-throttle in real time:

RateLimit-Limit: 120 (quota per window)
RateLimit-Remaining: remaining requests in window
RateLimit-Reset: seconds until quota refresh
RateLimit-Policy: 120;w=60
Retry-After: returned on HTTP 429 responses

Typed Error Model (RFC 9457)

All error responses use the standard application/problem+json media type with machine-readable error codes and resolution guidance:

{
  "type": "https://www.francionedesigngroup.com/docs#errors",
  "title": "Resource Not Found",
  "status": 404,
  "detail": "services not found",
  "code": "NOT_FOUND",
  "message": "services not found",
  "resolution": "Check the slug against GET /api/v1/services or review /openapi.json.",
  "path": "/api/v1/services/unknown-slug",
  "error": {
    "code": "NOT_FOUND",
    "message": "services not found",
    "resolution": "Check the slug against GET /api/v1/services or review /openapi.json."
  }
}

API Versioning & Deprecation Policy

The Francione Design Group API uses URI path versioning (/api/v1). Version 1.0.0 is stable, active, and fully backwards-compatible.

Deprecation Signaling: If an endpoint or API version is scheduled for deprecation, Francione Design Group will provide a minimum of 6 months advance notice. Deprecated endpoints will return standard RFC 8594 Deprecation: @<timestamp> and Sunset: <HTTP-date> headers.

Markdown Content Negotiation

All public web pages support Accept: text/markdown for agent-friendly page summaries. Responses include Vary: Accept, Accept-Encoding.

curl -s -H "Accept: text/markdown" https://www.francionedesigngroup.com/services