Skip to main content

Public API v1

Developer documentation

A small, read-only interface to the same human-approved public snapshots already shown on GFSA pages. It is intended for research discovery and transparent public-directory reuse—not account automation, certificate decisions, personalized advice, white-label delivery or tenant administration.

中文 · Open machine-readable manifest

GET / HEADapproved public snapshotsno write APIno browser CORS

Contract at a glance

  • Base URL: https://globalfengshui.org/api/v1
  • Methods: GET and HEAD. Other methods return 405.
  • Format: UTF-8 JSON; api_version identifies this contract.
  • Pagination: limit 1–50, default 20; pass the returned next_cursor as after.
  • Caching: successful public responses may be cached for up to 300 seconds.
  • Baseline traffic control: 100 site requests per 60 seconds per client under the current WAF baseline; tighter controls may apply.

Resources

EndpointContentsPublication boundary
/api/v1/membersPublic member/profile names, approved descriptions, enabled location/category codes and public identity badge state.Active profile and approved version; each profile display switch is reapplied.
/api/v1/organizationsPublic institution code, names, country, overview, scope and boundaries.Active organization with an approved public snapshot.
/api/v1/knowledgeReviewed terminology, definitions, cautions and source-coverage status.Active approved immutable entry version.
/api/v1/casesBroad bands and shortened deidentified case summaries, approaches, observations and limitations.Deidentified human-approved snapshot only.
/api/v1/industry-dataPublished annual aggregate snapshots and their public metrics.Published cycle/snapshot; metrics must have passed fixed privacy thresholds.

Examples

Read the capability manifest

curl --fail --silent \
  "https://globalfengshui.org/api/v1"

Read the first page

curl --fail --silent \
  "https://globalfengshui.org/api/v1/knowledge?limit=20"

Continue with the returned cursor

curl --fail --silent \
  "https://globalfengshui.org/api/v1/knowledge?limit=20&after=123"

Treat cursors as opaque continuation values. Do not use them as a statement of rank, completeness or endorsement.

Data that is deliberately absent

The API does not expose email, phone, websites or social contacts; account identifiers or credentials; exact birth or precise location data; payment data; service-delivery or report bodies; contributor and team identities; consent references; complaint or case evidence; individual survey responses; internal review notes, risk flags, suppression reasons or administrator identities.

Certificate records are not offered as a bulk API. Use the governed single-record verification page and assess scope, status and expiry in context.

Browser access, attribution and reliability

  • No Access-Control-Allow-Origin header is sent. Cross-origin browser JavaScript is not supported; use a same-origin or server-side integration.
  • When republishing, attribute the Global Feng Shui Association (GFSA), preserve the source profile URL and snapshot date, and do not imply endorsement or real-time status.
  • This is a best-effort public service with no uptime SLA. Handle 400, 404, 405, 429 and 5xx responses; retry transient failures with bounded exponential backoff.

White-label and multi-tenant boundary

GFSA organization roles are application permissions, not a cryptographic or database tenant boundary. The current Access-backed application is therefore not represented as a white-label or multi-tenant SaaS platform. A future offering would require a service database with enforced tenant keys and row isolation, per-tenant secrets and audit/rate controls, independent backup/restore and residency processes, contractual privacy controls, security testing and governed custom-domain/branding operations.

Terms and questions

Use is subject to the site terms, privacy notice and intellectual-property notices. Public availability does not waive third-party rights or permit misleading, discriminatory, automated eligibility, credit, employment, insurance, health, legal or other high-impact decisions.