Search path

This endpoint is the main endpoint for searching through all paths you have access to, supporting filtering arguments such as the type of path, the root folder to look in, text matching the paths data, as well as supporting additional refining arguments for searching raster, vector and point cloud data.

Description	Search for paths matching specified search criteria.
Endpoint	/path
Method	GET

Access Level Rules

Access Level	None

Processing Units

Processing units	0

Parameters

General Search

Name	Description	Required	Default
type	An array that indicates the path types you are looking for with the following possible options: "type": [ "vector", "raster", "folder", "file", "pointCloud", "bookmark" ]	false	Default ["vector", "raster", "folder", "file", "pointCloud", "bookmark"].
root	Array of root folders to search through. Elements must be one of "myDrive", "sharedWithMe", "trash", "favorites" or "public".	false	Default ["public", "sharedWithMe", "myDrive", "favorites", "trash"].
text	Searches for paths with text containing words that start with the given text. The text that can be searched includes the name of the path, the description of the path and its timestamp, the names of the styles and all hashtags attached to a given path. "text" must contain valid unicode letters or numbers, all unicode symbols and punctuation are ignored.	false	Default null.
userId	Search for paths owned by the given user.	false	Default null.
pageSize	The maximum number of paths to return. Maximum 100.	false	Default 100.
pageStart	The nextPageStart as returned in a previous search paths request to retrieve the next batch of searched paths.	false	Default null.
hashtag	Searches for paths with the given hashtag.	false	Default null.

Layer Search (for vectors, rasters and point clouds)

Name	Description	Required	Default
active	Boolean to search for maps that have or do not have active data.	false	Default null.
resolution	JSON with properties "min" and "max" defining the minimum/maximum resolution the layers should have.	false	Default null.
extent	JSON with properties "xMin", "xMax", "yMin" and "yMax" defining the geographic extent with which the resulting layer should overlap.	false	Default null.
date	JSON with the properties "from" and "to" defining the time range which the timestamps of the map should overlap with.	false	Default null.