Skip to content
Micro micro
Go to Micro
API Reference
Views

Read a view bundle

GET/v2/prism/{teamId}/{viewObjectType}/views/{viewId}

Returns the view bundle. Pass ?include=records to also fetch a page of records selected by the view in the same call; the response is then wrapped as {view, records}.

Path ParametersExpand Collapse
teamId: optional string
formatuuid
viewObjectType: "action" or "deal" or "document" or 3 more
One of the following:
"action"
"deal"
"document"
"event"
"identity"
"organization"
viewId: string
formatuuid
Query ParametersExpand Collapse
cursor: optional string

Forwarded to the records sub-resource when include=records.

include: optional string

Comma-separated list of optional sub-resources to inline. Currently the only recognized value is records — when present, the response is {view, records} rather than the bare view bundle.

limit: optional number

Forwarded to the records sub-resource when include=records.

minimum0
maximum50
page: optional number

Forwarded to the records sub-resource when include=records.

minimum1
ReturnsExpand Collapse
ViewBundle object { name, view_type, id, 18 more }

A view (saved configuration for displaying records of a given object type) plus its select/filter/sort children. Properties in select/filter/sort are referenced by slug.

name: string
view_type: string
id: optional string
formatuuid
aggregation_prop_def_id: optional string
formatuuid
aggregation_type: optional string
column_layout: optional map[unknown]
combinator: optional "AND" or "OR"
One of the following:
"AND"
"OR"
created_at: optional string
filter: optional array of map[unknown]

Each entry is { slug: { comparator: value } }

group_by: optional string

Property slug to group by

group_hidden_option_ids: optional array of unknown or unknown
One of the following:
array of unknown
unknown
group_hide_empty: optional boolean
group_sort: optional string
icon: optional string
list_id: optional string
formatuuid
select: optional array of string

Property slugs (dot-paths permitted for refs)

sort: optional array of map[unknown]

Each entry is { slug: ‘asc’ | ‘desc’ }

sort_order: optional number
team_id: optional string
formatuuid
updated_at: optional string
user_id: optional string
ViewBundleWithRecords object { records, view }

Returned by GET /views/{viewId}?include=records. Same records shape as the standalone list-view-records endpoint.

records: object { data, has_more, next_cursor }
data: array of map[unknown]
has_more: boolean
next_cursor: optional string
view: object { name, view_type, id, 18 more }

A view (saved configuration for displaying records of a given object type) plus its select/filter/sort children. Properties in select/filter/sort are referenced by slug.

name: string
view_type: string
id: optional string
formatuuid
aggregation_prop_def_id: optional string
formatuuid
aggregation_type: optional string
column_layout: optional map[unknown]
combinator: optional "AND" or "OR"
One of the following:
"AND"
"OR"
created_at: optional string
filter: optional array of map[unknown]

Each entry is { slug: { comparator: value } }

group_by: optional string

Property slug to group by

group_hidden_option_ids: optional array of unknown or unknown
One of the following:
array of unknown
unknown
group_hide_empty: optional boolean
group_sort: optional string
icon: optional string
list_id: optional string
formatuuid
select: optional array of string

Property slugs (dot-paths permitted for refs)

sort: optional array of map[unknown]

Each entry is { slug: ‘asc’ | ‘desc’ }

sort_order: optional number
team_id: optional string
formatuuid
updated_at: optional string
user_id: optional string

Read a view bundle

curl https://developers.micro.so/v2/prism/$TEAM_ID/$VIEW_OBJECT_TYPE/views/$VIEW_ID \
    -H "x-api-key: $MICRO_API_KEY"
{
  "name": "name",
  "view_type": "view_type",
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "aggregation_prop_def_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "aggregation_type": "aggregation_type",
  "column_layout": {
    "foo": "bar"
  },
  "combinator": "AND",
  "created_at": "created_at",
  "filter": [
    {
      "foo": "bar"
    }
  ],
  "group_by": "group_by",
  "group_hidden_option_ids": [
    {}
  ],
  "group_hide_empty": true,
  "group_sort": "group_sort",
  "icon": "icon",
  "list_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "select": [
    "string"
  ],
  "sort": [
    {
      "foo": "bar"
    }
  ],
  "sort_order": 0,
  "team_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "updated_at": "updated_at",
  "user_id": "user_id"
}
Returns Examples
{
  "name": "name",
  "view_type": "view_type",
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "aggregation_prop_def_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "aggregation_type": "aggregation_type",
  "column_layout": {
    "foo": "bar"
  },
  "combinator": "AND",
  "created_at": "created_at",
  "filter": [
    {
      "foo": "bar"
    }
  ],
  "group_by": "group_by",
  "group_hidden_option_ids": [
    {}
  ],
  "group_hide_empty": true,
  "group_sort": "group_sort",
  "icon": "icon",
  "list_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "select": [
    "string"
  ],
  "sort": [
    {
      "foo": "bar"
    }
  ],
  "sort_order": 0,
  "team_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "updated_at": "updated_at",
  "user_id": "user_id"
}