Skip to main content

Create a saved workspace view

Save a named view configuration for a supported workspace, including the Signals workspace UI.

POST/api/workspace-views
HTTP referenceScope workspace_views:writeUpdated September 27, 2026

This page documents the canonical HTTP contract for this endpoint.

Developer API keys need the listed scope. A valid authenticated user session may also call this route.

Saved views are scoped to the authenticated organization and user: organization-visible views and the caller’s private views may be listed, and mutation access is limited to editable views.

The raw view routes also accept workspace=signals. Developer keys use workspace_views:read to list and workspace_views:write to mutate these saved views; authenticated user sessions are also supported. This documents the raw endpoint behavior; the registered crm.saved_views list operation continues to describe Leads and Companies. Signals filter/topic values are preserved instead of receiving legacy CRM field-token rewrites. Shared view normalization still applies; typed filter descriptors and query_sort are supported for Leads views only.

Setting is_default clears the caller’s existing default view in that workspace. The config example is schematic; field tokens and filters should come from the applicable workspace catalog.

Body parameters

  • workspacerequired

    string

    companies, leads, tasks, or signals.

  • namerequired

    string

    Non-empty name, truncated to 120 characters.

  • visibility · optional

    string

    private or org; unsupported values normalize to org.

  • config · optional

    object

    Workspace-specific saved view configuration; omitted or non-object values normalize to workspace defaults. When supplying sort, the canonical shape is {field,order}, with order asc|desc; legacy direction is accepted and normalized to order.

  • is_default · optional

    boolean

    When true, makes the created view the caller’s default for this workspace.

Errors

StatusMeaning
401Authentication is missing or invalid.
403The credential is invalid or lacks the required scope, or the caller cannot access the resource.
400Workspace, name, or configuration is invalid, or organization/user context is missing.

Docs