Skip to main content
GET
Search workspace
Find a specific recording link, project, domain, or teammate inside a workspace by name. Use this endpoint to power typeahead pickers, quick-jump UIs, or any flow where a user types a few characters to locate a resource. Pass the resource kind as type and the search text as q. Each type uses the matching strategy best suited for its data:
  • links — Postgres full-text search with prefix matching, ranked by relevance
  • members — case-insensitive match on member name
  • projects — case-insensitive match on project title
  • domains — case-insensitive match on domain URL
The response is a discriminated union keyed on type, so data.type tells you which shape data.results has.

Errors

Also returns common authentication errors.

List Links

Paginate through all links in a workspace

List Projects

Paginate through all projects in a workspace

Authorizations

Authorization
string
header
required

API key with uspl_ prefix. Create keys at dash.userplane.io/_/account?tab=developers

Path Parameters

workspaceId
string
required
Minimum string length: 1

Query Parameters

q
string
required
Required string length: 1 - 100
type
enum<string>
required
Available options:
members,
projects,
domains,
links
limit
integer
default:5
required
Required range: 1 <= x <= 20

Response

OK

message
string
required
data
object
required