Get Route

Returns a route by its ID or pathname.

GET /v2/routes/{routeIdOrPathname}

Get Route

cURL

curl --request GET \
  --url https://api.makeswift.com/v2/routes/{routeIdOrPathname} \
  --header 'x-api-key: <api-key>'

200

{
  "object": "route",
  "id": "37b18c41-9752-4adf-9aef-f42ab4f74b04",
  "pathname": "/furniture"
}

Authorizations

x-api-key · string · header · required

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

routeIdOrPathname · string · required

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

Query Parameters

siteId · string<uuid>

The site ID required when using a pathname instead of a route ID.

Response

200

application/json

The route.

object · enum<string> · required

Available options: route

id · string<uuid> · required

The ID of the route.

pathname · string · required

The route pathname.

Example:

"/furniture"