List Routes

Returns a list of routes for a site.

GET /v2/routes

List Routes

cURL

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

200

{
  "object": "list",
  "data": [
    {
      "object": "route",
      "id": "37b18c41-9752-4adf-9aef-f42ab4f74b04",
      "pathname": "/furniture"
    }
  ],
  "hasMore": true
}

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)

Query Parameters

siteId · string<uuid> · required

The site ID to list routes from.

limit · number · default: 20

The maximum number of routes to return.

Required range: 1 <= x <= 100

startingAfter · string<uuid>

The pagination cursor. This is used to indicate what ID to list from.

Response

200

application/json

object · enum<string> · required

Available options: list

data · object[] · required

Show child attributes

hasMore · boolean · required

The flag that indicates whether there are more routes available.