ReferenceREST APIAPI ReferenceRoute

List Routes

Returns a list of routes for a site.

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)

Query parameters

siteIdstringRequiredformat: "uuid"
The site ID to list routes from.
limitdoubleOptional1-100Defaults to 20
The maximum number of routes to return.
startingAfterstringOptionalformat: "uuid"
The pagination cursor. This is used to indicate what ID to list from.

Response

objectenum
Allowed values:
datalist of objects
hasMoreboolean
The flag that indicates whether there are more routes available.

Errors