Search#

Search workspace records across campaigns, creators, activities, and media providers.

Authentication required

All endpoints require a Bearer token in the Authorization header. See the Authentication guide for setup instructions.

Search a workspace for campaigns, creators, activities across every channel, and media providers by name or activity caption. Returns a small ranked result set for global navigation and record discovery.

bash
GET /v1/search?workspace_id=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01&query=...&limit_per_type=...
Authorization: Bearer {token}

Parameters#

NameTypeRequiredDescription
workspaceIdstring (UUID)RequiredWorkspace identifier.
querystringRequiredCase-insensitive workspace search query (2-100 characters).
limitPerTypeintegerRequiredMaximum results returned for each record type (1-10).

Response#

Returns { items, totalCount, facets, _meta } with paginated results.