---
title: "Search for workspaces"
method: POST
path: "/workspaces/search"
tags: ["workspaces"]
---

# Search for workspaces

`POST /workspaces/search`

Based on workspace properties (currently only name) search for workspaces.

## Request body

- NameSearch
  - `name` string, required — The name to be used when searching - this will be used in a case insensitive starts with match.

## Response `200`

Returns the workspaces that were found based on the search parameters.

- WorkspaceSearch
  - `data` object[], required
    - `name` string, required — The name of the app.
    - `url` string, required — The URL by which the app is accessed, this must be URL encoded.
    - `_id` string, required — The ID of the app.
    - `status` 'development' | 'published', required — The status of the app, stating it if is the development or published version.
    - `createdAt` string, required — States when the app was created, will be constant. Stored in ISO format.
    - `updatedAt` string, required — States the last time the app was updated - stored in ISO format.
    - `version` string, required — States the version of the Budibase client this app is currently based on.
    - `tenantId` string — In a multi-tenant environment this will state the tenant this app is within.
    - `lockedBy` object — The user this app is currently being built by.

---

[API](https://skmtc.net/budibase/apis/budibase-api.md) · [All operations](https://skmtc.net/budibase/apis/budibase-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/budibase/budibase-api/revisions/9c6f16fc652b/schema)