Skip to content

Create Object View

POST
/objects/{object_slug}/views

Save a private or shared view owned by this credential, without impersonating a human.

Authorizations

Parameters

Path Parameters

object_slug
required
string

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
state
object
columns
Any of:
Array<string>
<= 200 items
filters
Array<object>
<= 10 items

Filter parameters for listing records.

object
attribute_slug
required
string
operator
required
string
Allowed values: eq ne gt gte lt lte contains starts_with in is_null is_not_null
value
Any of:
groupBy
Any of:
string
includeArchived
boolean
layout
string
default: table
Allowed values: table board
search
string
"" <= 200 characters
sortBy
Any of:
string
sortOrder
string
default: desc
Allowed values: asc desc
version
integer
default: 1
title
required
string
>= 1 characters <= 120 characters
visibility

Who can apply a view. Only the creator can update or delete it.

string
default: private
Allowed values: private org

Responses

201

Successful Response

object
data
required

Response shape — flat shape with state at top level for convenience.

object
context_key
required
Any of:
string
created_at
required
Any of:
string format: date-time
created_by
required
string
description
required
Any of:
string
entity_type
required

Which CRM grid the saved view applies to. Free-form string at the DB level (cb_saved_views.entity_type is VARCHAR(50)) to avoid a schema migration when we add deals/tasks/leads — but enforced as an enum at the API boundary so we don’t accept typos.

NEITHER A SUBSET NOR A SUPERSET OF FilterEntityType — see the invariant on that class, and the sibling docstring below, which states the same relationship from the other side. The two enums overlap on the four GRID values (contacts, companies, deals, leads); FilterEntityType is a superset of THOSE and adds report, while the list/view/search/workbench/ads members here have no counterpart there. Custom objects additionally use an object-bound view context.

(This paragraph previously read “DELIBERATELY NARROWER THAN FilterEntityType”, which inverted the relationship: this is the LARGER enum. The narrowness that matters is real but specific — report is excluded, and only report — so stating it as a general containment invited exactly the wrong conclusion about the other nine.)

Native grid members can be saved with context_key = NULL for reuse across that entity type. CUSTOM_OBJECTS is the exception: it requires an immutable object context and the object-authorized endpoints. It must never enter the native grids’ reusable saved-filter menus.

The five ADS_* members are the Google Ads ad-group grids’ remembered column state (shown, hidden, order), one private view per user per grid with context_key = NULL. Their state carries columnPrefs and never a filter tree, so none of them belongs in FilterEntityType. They are separate members, not a reuse of an existing grid’s type, because a list read returns every view of an entity type: a column-state row filed under contacts would appear in the Contacts “Saved filters” menu.

string
Allowed values: custom_objects contacts companies deals leads lists contacts_view companies_view list_contacts list_companies search_people search_companies abm_companies enrichment_workbench enrichment_workbenches ads_ad_groups ads_campaign_ads ads_ad_group_ads ads_campaign_keywords ads_ad_group_keywords
id
required
string format: uuid
is_default
required
boolean
is_owner
required
boolean
is_reusable
required
boolean
state
required
object
key
additional properties
any
title
required
string
updated_at
required
Any of:
string format: date-time
visibility
required

Who can apply a view. Only the creator can update or delete it.

string
Allowed values: private org
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string