Skip to main content
GET
Search for Platform Entities

Authorizations

Authorization
string
header
required

Enter your bearer token in the format: Bearer {token}

Query Parameters

q
string
required

The primary search query string. The search engine performs a fuzzy search across entity names, descriptions, and key metadata fields.

Required string length: 1 - 255
workspace_id
string

The unique identifier for a Workspace (ws_...). Specifying this ID scopes the search exclusively to entities within that workspace, overriding the broader organization-level scope. Cannot be used with org_id.

org_id
string

The unique identifier for an Organization (org_...). Allows an administrator to override the default search scope from their own organization to another. Cannot be used with workspace_id.

types
string[]

An array of entity types to filter the search results. Only entities matching one of the provided types will be returned.

created_from
string<date>

The start date for a date-range filter on the entity's creation timestamp. Formatted as YYYY-MM-DD.

created_to
string<date>

The end date for a date-range filter on the entity's creation timestamp. Formatted as YYYY-MM-DD.

page
integer
default:1

The page number of the result set to retrieve.

Required range: x >= 1

Response

A paginated list of matching entities.

data
object[]
meta
object