EndpointsCollections
Get collection by ID or share token
`ref` is a numeric collection ID (owners: any visibility; non-owners: public only, so sequential IDs can't be walked to discover unlisted collections) or a 32-hex share token (public and unlisted). Private routes inside are omitted for non-owners. Private collections return 404 to non-owners. Owners authenticate with a cookie session or any PAT.
GET
ref*stringCollection ID or 32-hex share token
application/json- response
id*numbername*stringdescription?stringvisibility*stringValue in
"private""unlisted""public"routeIds*array<number>Ordered route IDs in this collection. For non-owners, private routes are omitted.
routeCount*numberNumber of routes in the collection (after visibility filtering)
shareToken*stringUnguessable 32-hex handle for share links. Unlisted collections are only reachable anonymously via this token.
user*createdAt*stringupdatedAt*stringroutes*array<>Ordered routes in this collection. For non-owners, private routes are omitted.
curl -X GET 'https://api.routess.com/collections/string'{ "id": 0, "name": "string", "description": "string", "visibility": "private", "routeIds": [ 0 ], "routeCount": 0, "shareToken": "9f86d081884c7d659a2feaa0c55ad015", "user": { "id": 1, "name": "Jane Doe", "handle": "jane-doe", "avatar": "https://example.com/avatar.jpg", "idHash": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08" }, "createdAt": "string", "updatedAt": "string", "routes": [ { "id": 0, "name": "string", "description": "string", "activity": "run", "visibility": "private", "tags": [ "string" ], "favourite": true, "waypoints": [ { "coord": [ -74.006, 40.7128 ], "type": "routed", "name": "string", "timestamp": "string" } ], "geometry": [ "string" ], "distance": 0, "duration": 0, "elevationGain": 0, "startAddress": "string", "endAddress": "string", "placeCity": "string", "placeRegion": "string", "placeCountryCode": "string", "routingPreferences": { "surfacePreference": "mixed", "avoidFerries": true, "avoidHighways": true }, "provenance": "valhalla", "shareToken": "9f86d081884c7d659a2feaa0c55ad015", "user": { "id": 1, "name": "Jane Doe", "handle": "jane-doe", "avatar": "https://example.com/avatar.jpg", "idHash": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08" }, "createdAt": "string", "updatedAt": "string" } ]}