Skip to main content
GET
/
v2
/
routes
List Routes
curl --request GET \
  --url https://api.makeswift.com/v2/routes \
  --header 'x-api-key: <api-key>'
{
  "object": "list",
  "data": [
    {
      "object": "route",
      "id": "37b18c41-9752-4adf-9aef-f42ab4f74b04",
      "pathname": "/furniture"
    }
  ],
  "hasMore": true
}

Authorizations

​
x-api-key
string
header
required

The App API key.

(e.g. sk_eczMHVBY9fV6GYFhvs53qcnxq7yptlXL3ABKOZtn6dQ)

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
​
starting_after
string<uuid>

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

Response

​
object
enum<string>
required
Available options:
list
​
data
object[]
required
​
hasMore
boolean
required

The flag that indicates whether there are more routes available.