ReferenceREST APIAPI ReferenceRoute

Get Route

Returns a route by its ID or pathname.

Authentication

x-api-keystring
API key authentication. Accepts either: - App API key (e.g. sk_eczMHVBY9fV6GYFhvs53qcnxq7yptlXL3ABKOZtn6dQ) - Site API key (UUID format, e.g. 550e8400-e29b-41d4-a716-446655440000)

Path parameters

routeIdOrPathnamestringRequired
The route ID or pathname for the route you are requesting.

Query parameters

siteIdstringOptionalformat: "uuid"
The site ID required when using a pathname instead of a route ID.

Response

objectenum
Allowed values:
idstringformat: "uuid"
The ID of the route.
pathnamestring
The route pathname.

Errors