# 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

{% tabs %}
{% tab title="General Search" %}

<table><thead><tr><th width="247">Name</th><th width="552">Description</th><th>Required</th><th>Default</th></tr></thead><tbody><tr><td><code>type</code></td><td><p>An array that indicates the path types you are looking for with the following possible options:<br><br><code>"type": [</code><br><code>"vector",</code><br><code>"raster",</code><br><code>"folder",</code></p><p><code>"file",</code></p><p><code>"pointCloud",</code></p><p><code>"bookmark"</code><br><code>]</code></p></td><td>false</td><td>Default ["vector", "raster", "folder", "file", "pointCloud", "bookmark"].</td></tr><tr><td><code>root</code></td><td>Array of root folders to search through. Elements must be one of "myDrive", "sharedWithMe", "trash", "favorites" or "public". </td><td>false</td><td>Default ["public", "sharedWithMe", "myDrive", "favorites", "trash"].</td></tr><tr><td><code>text</code></td><td>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.</td><td>false</td><td>Default null.</td></tr><tr><td><code>userId</code></td><td>Search for paths owned by the given user.</td><td>false</td><td>Default null.</td></tr><tr><td><code>pageSize</code></td><td>The maximum number of paths to return. Maximum 100.</td><td>false</td><td>Default 100.</td></tr><tr><td><code>pageStart</code></td><td>The nextPageStart as returned in a previous search paths request to retrieve the next batch of searched paths.</td><td>false</td><td>Default null.</td></tr><tr><td><code>hashtag</code></td><td>Searches for paths with the given hashtag. </td><td>false</td><td>Default null.</td></tr></tbody></table>
{% endtab %}

{% tab title="Layer Search  (for vectors, rasters and point clouds) " %}

<table><thead><tr><th width="282">Name</th><th width="429">Description</th><th width="150">Required</th><th>Default</th></tr></thead><tbody><tr><td><code>active</code></td><td>Boolean to search for maps that have or do not have active data.</td><td>false</td><td>Default null.</td></tr><tr><td><code>resolution</code></td><td>JSON with properties "min" and "max" defining the minimum/maximum resolution the layers should have.</td><td>false</td><td>Default null.</td></tr><tr><td><code>extent</code></td><td>JSON with properties "xMin", "xMax", "yMin" and "yMax" defining the geographic extent with which the resulting layer should overlap.</td><td>false</td><td>Default null.</td></tr><tr><td><code>date</code></td><td>JSON with the properties "from" and "to" defining the time range which the timestamps of the map should overlap with.</td><td>false</td><td>Default null.</td></tr></tbody></table>
{% endtab %}
{% endtabs %}