Routes

Get one route by path

Returns the route at path, including staged changes. The home page is …/routes/ (trailing slash). Other paths are sent without the leading slash, for example …/routes/blog/launch for /blog/launch.

get/api/v1/sites/{slug}/routes/{path}

Request

  • Base URL: https://api.dotsy.ai
  • URL: https://api.dotsy.ai/api/v1/sites/{slug}/routes/{path}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

slugstring required
Example:acme-studio

Site slug or site id (UUID). An old slug answers 301/308 and a site id 307 to the canonical slug path.

pathstring required

Percent-encode each segment; '/' may be sent raw or as %2F. Keys may contain '/'.

Response

The route.

pathstring required

The URL path. The home page is /. A :param segment makes a pattern route.

contentKeystring nullable required

The content key this route serves. Null on a redirect, and on a route with no explicit key (it then serves the key derived from its path).

layoutstring nullable required

Layout file key, for example layouts/main.html.

titlestring nullable required

Page title.

varsobject nullable required

Template variables passed to the layout.

purposestring nullable required

redirect for a redirect route, otherwise null.

redirectTostring nullable required

Redirect target, a root-relative path. Set only when purpose is redirect.

preserveQueryboolean nullable required

Whether a redirect appends the visitor's query string to its target. Null means the default (true).

navLabelstring nullable required

Deprecated. Menu link text — use the menu API instead.

noindexboolean nullable

True when the page is excluded from the sitemap and marked noindex.

createdBy'person' | 'ai' | 'key' | 'move' nullable

Who made this route a redirect: a signed-in person, an ai (MCP OAuth), an API key, or a page move. Present only on redirects.

createdByIdstring nullable

The user id when createdBy is person.

updatedAtnumber required

Last change, Unix ms.

Example response

{
  "path": "/about",
  "contentKey": "about.html",
  "layout": "layouts/main.html",
  "title": "About us"
}

Changes

No recorded changes to this operation across all 1 revision of this API.