Shareable Links to a Specific API Endpoint

“Check the docs” is a weak instruction when the docs page has 200 endpoints and no way to point at one of them. Deep linking — a URL that opens straight to a specific endpoint or schema, not just the docs homepage — turns “check the docs” into a link someone can click and land in the right place immediately.

Where this actually gets used

It’s easy to file deep linking under “nice to have,” but it shows up constantly in ordinary workflows:

• Support tickets — pasting a link to the exact endpoint a customer is asking about, instead of a written description of where to scroll.
• Code review — linking a reviewer directly to the response schema a PR changes, so they don’t have to hunt for it in a long spec.
• Onboarding — a written runbook that links straight to “the auth endpoint” or “the webhook payload shape,” rather than “open the docs and find it.”
• Cross-referencing between services — one team’s internal docs linking to the exact endpoint on another team’s API, rather than to that team’s docs homepage.

Without it, all four of these degrade to “open the docs and scroll” or “here’s a screenshot,” both of which go stale the moment the spec changes.

The general pattern

Under the hood, this is almost always a URL fragment (the part after #) that the docs viewer reads on load and uses to scroll to — and highlight — the matching element. Because it’s a fragment rather than a query parameter, it works with static hosting (GitHub Pages, a CDN, anything with no server-side routing) and doesn’t get stripped by caching layers that only key on the path.

How GetMan implements it

Every endpoint and schema GetMan renders gets a predictable fragment automatically — nothing to configure per endpoint:

https://your-docs.example.com/#endpoints/<operationId>
https://your-docs.example.com/#schemas/<SchemaName>

Append either to the URL of any page that embeds GetMan, and on load it scrolls directly to that endpoint or schema. operationId and schema names come straight from your OpenAPI spec, so the links stay stable as long as those identifiers don’t change — which is also why giving your endpoints explicit operationId values (rather than letting a generator auto-derive them) is worth doing if you plan to link into your docs regularly.

A concrete example

For an endpoint defined with operationId: getUserById, the shareable link is:

https://your-docs.example.com/#endpoints/getUserById

Paste that directly into a Slack message, a ticket, or a PR comment, and it opens the docs scrolled to that exact endpoint — no “scroll down, it’s under Users” required.

See the docs for the full fragment reference, or the alternatives pages if you’re evaluating whether your current viewer supports this at all — it’s a common gap, not a given.