# Gateway Global APIs — documentation for developers and agents

Gateway Global Ltd publishes one public API, plus a set of machine-readable
discovery documents. This page describes what exists, what does not, and how to
get access to the parts that are not public.

- **API catalog (RFC 9727):** <https://gateway-global.co.uk/.well-known/api-catalog>
- **OpenAPI description:** <https://gateway-global.co.uk/api/v1/openapi.json>
- **Contact:** <Assist@Gateway-Global.co.uk>

---

## Scope — read this first

| Interface | Public? | Where |
|---|---|---|
| Gateway Global Public Data API | Yes, unauthenticated | `https://gateway-global.co.uk/api/v1/` |
| Prime Assist voice-agent platform | **No** — delivered under contract | Email us |
| Clinical integrations (EMIS, SystmOne, Vision, NHS Spine) | **No** — delivered under contract | Email us |
| SimpleTemp dental staffing | **No** public API | <https://simpletemp.co.uk> |

The Public Data API describes Gateway Global **as a company**. It carries no
patient data, no clinical data, and no customer data of any kind. Nothing in it
is confidential — it is the same information already published on the website,
offered in a form that machines can consume without scraping HTML.

Prime Assist itself is a contracted platform that runs inside a customer's
clinical estate. It has no public endpoint, no public OAuth server and no
self-service sign-up. If you need programmatic access, email
<Assist@Gateway-Global.co.uk>; access is granted under a signed agreement and
credentials are issued directly.

---

## Gateway Global Public Data API v1

**Base URL:** `https://gateway-global.co.uk/api/v1/`

Every endpoint is a static JSON document served from the site origin.

- Method: `GET` only.
- Authentication: none. Do not send credentials.
- Query parameters: none. Pagination: none.
- Rate limits: none published; be reasonable, and cache.
- Media type: `application/json`.
- Stability: the `v1` path is stable. Breaking changes ship as `v2`.
- Availability: a successful fetch is the health signal — there is no runtime
  component that can fail independently of the site itself.

### Endpoints

| Endpoint | Returns |
|---|---|
| [`GET /api/v1/index.json`](https://gateway-global.co.uk/api/v1/index.json) | API metadata and the resource list. |
| [`GET /api/v1/status.json`](https://gateway-global.co.uk/api/v1/status.json) | Static readiness document. |
| [`GET /api/v1/company.json`](https://gateway-global.co.uk/api/v1/company.json) | Legal entity, registered address, contact routes, products, compliance posture, public-record submissions. |
| [`GET /api/v1/solutions.json`](https://gateway-global.co.uk/api/v1/solutions.json) | The nine voice-AI solutions, the nine healthcare workflows, and the technology stack summary. |
| [`GET /api/v1/industries.json`](https://gateway-global.co.uk/api/v1/industries.json) | The eight regulated industries served. |
| [`GET /api/v1/faq.json`](https://gateway-global.co.uk/api/v1/faq.json) | Published questions and answers. |

### Example

```bash
curl -sS https://gateway-global.co.uk/api/v1/company.json | jq '.legalName, .companyNumber'
```

```
"Gateway Global Ltd"
"15115768"
```

### Errors

There is no error envelope. A missing or misspelled path returns the site's
standard 404 response. A `200` always carries the document described by the
OpenAPI schema.

---

## Other machine-readable resources

| Resource | Media type | Purpose |
|---|---|---|
| [`/.well-known/api-catalog`](https://gateway-global.co.uk/.well-known/api-catalog) | `application/linkset+json` | RFC 9727 API catalog. |
| [`/.well-known/agent-skills/index.json`](https://gateway-global.co.uk/.well-known/agent-skills/index.json) | `application/json` | Agent Skills discovery index. |
| [`/.well-known/mcp/server-card.json`](https://gateway-global.co.uk/.well-known/mcp/server-card.json) | `application/json` | MCP Server Card describing the site's MCP surface. |
| [`/.well-known/oauth-protected-resource`](https://gateway-global.co.uk/.well-known/oauth-protected-resource) | `application/json` | OAuth Protected Resource Metadata. |
| [`/.well-known/oauth-authorization-server`](https://gateway-global.co.uk/.well-known/oauth-authorization-server) | `application/json` | OAuth Authorization Server Metadata. |
| [`/auth.md`](https://gateway-global.co.uk/auth.md) | `text/markdown` | How an agent obtains access to non-public interfaces. |
| [`/index.md`](https://gateway-global.co.uk/index.md) | `text/markdown` | The homepage as Markdown. |
| [`/llms.txt`](https://gateway-global.co.uk/llms.txt) | `text/plain` | Orientation file for language models. |
| [`/.well-known/security.txt`](https://gateway-global.co.uk/.well-known/security.txt) | `text/plain` | Security contact (RFC 9116). |
| [`/sitemap.xml`](https://gateway-global.co.uk/sitemap.xml) | `application/xml` | Sitemap. |

## Content negotiation

Send `Accept: text/markdown` to any HTML page on this site and you will receive
a Markdown rendering instead of HTML, with `Content-Type: text/markdown`. HTML
remains the default for browsers.

```bash
curl -sS -H 'Accept: text/markdown' https://gateway-global.co.uk/
```

## Discovery via response headers

The homepage advertises these resources in `Link` response headers (RFC 8288),
so an agent can find them from a single request:

```bash
curl -sSI https://gateway-global.co.uk/ | grep -i '^link:'
```

## Terms

Use of these documents is subject to the
[Terms](https://gateway-global.co.uk/#/legal/terms) and
[Privacy policy](https://gateway-global.co.uk/#/legal/privacy). Content usage
preferences for AI systems are declared as Content Signals in
[`/robots.txt`](https://gateway-global.co.uk/robots.txt).

Questions: <Assist@Gateway-Global.co.uk>
