Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Your Moonbase API key.

Path Parameters

id
string
required

The ID of the view to retrieve.

Response

Successful response.

A View represents a saved configuration for displaying items in a collection, including filters and sorting rules.

type
string
required

String representing the object’s type. Always view for this object.

Allowed value: "view"
id
string
required

Unique identifier for the object.

view_type
enum<string>
required

The type of view, such as table or board.

Available options:
table,
board
name
string
required

The name of the view.

collection
CollectionPointer · object
required

The Collection this view belongs to.

filter
Match Value · object
required

The filter applied to the view's items, or null when the view has no filter.

sort
string[]
required

Sort items returned by the specified fields. Empty when the view has no sort.

groups
string[]
required

Fields whose values group the view's items. Empty when the view is not grouped.

Maximum array length: 1

Identifies a field directly (name) or through relations (organization.name, deals.owner.email). Every segment before the last is a relation field; the last is the field you want. Keys preferred; use ids to disambiguate where there are multiple allowed collections.

aggregates
(Item Count · object | Field Statistic · object)[]
required

The metrics computed over the view's items.

Counts the view's items.

fields
ViewField · object[]
required

The view's columns, in display order.

Minimum array length: 1
relation_value_filters
ViewRelationValueFilter · object[]
required

Filters limiting which related items the view's relation columns show.

created_at
string<date-time>
required

Time at which the object was created, as an ISO 8601 timestamp in UTC.

updated_at
string<date-time>
required

Time at which the object was last updated, as an ISO 8601 timestamp in UTC.