## Read a view bundle

`client.views.get(stringviewID, ViewGetParamsparams, RequestOptionsoptions?): ViewGetResponse`

**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}`.

### Parameters

- `viewID: string`

- `params: ViewGetParams`

  - `teamId?: string`

    Path param

  - `viewObjectType: "action" | "deal" | "document" | 3 more`

    Path param

    - `"action"`

    - `"deal"`

    - `"document"`

    - `"event"`

    - `"identity"`

    - `"organization"`

  - `cursor?: string`

    Query param: Forwarded to the records sub-resource when `include=records`.

  - `include?: string`

    Query param: 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?: number`

    Query param: Forwarded to the records sub-resource when `include=records`.

  - `page?: number`

    Query param: Forwarded to the records sub-resource when `include=records`.

### Returns

- `ViewGetResponse = ViewBundle | ViewBundleWithRecords`

  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.

  - `ViewBundle`

    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?: string`

    - `aggregation_prop_def_id?: string | null`

    - `aggregation_type?: string | null`

    - `column_layout?: Record<string, unknown> | null`

    - `combinator?: "AND" | "OR"`

      - `"AND"`

      - `"OR"`

    - `created_at?: string`

    - `filter?: Array<Record<string, unknown>>`

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

    - `group_by?: string | null`

      Property slug to group by

    - `group_hidden_option_ids?: Array<unknown> | unknown | null`

      - `Array<unknown>`

      - `unknown`

    - `group_hide_empty?: boolean | null`

    - `group_sort?: string | null`

    - `icon?: string | null`

    - `list_id?: string | null`

    - `select?: Array<string>`

      Property slugs (dot-paths permitted for refs)

    - `sort?: Array<Record<string, unknown>>`

      Each entry is { slug: 'asc' | 'desc' }

    - `sort_order?: number | null`

    - `team_id?: string | null`

    - `updated_at?: string | null`

    - `user_id?: string | null`

  - `ViewBundleWithRecords`

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

    - `records: Records`

      - `data: Array<Record<string, unknown>>`

      - `has_more: boolean`

      - `next_cursor?: string | null`

    - `view: View`

      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?: string`

      - `aggregation_prop_def_id?: string | null`

      - `aggregation_type?: string | null`

      - `column_layout?: Record<string, unknown> | null`

      - `combinator?: "AND" | "OR"`

        - `"AND"`

        - `"OR"`

      - `created_at?: string`

      - `filter?: Array<Record<string, unknown>>`

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

      - `group_by?: string | null`

        Property slug to group by

      - `group_hidden_option_ids?: Array<unknown> | unknown | null`

        - `Array<unknown>`

        - `unknown`

      - `group_hide_empty?: boolean | null`

      - `group_sort?: string | null`

      - `icon?: string | null`

      - `list_id?: string | null`

      - `select?: Array<string>`

        Property slugs (dot-paths permitted for refs)

      - `sort?: Array<Record<string, unknown>>`

        Each entry is { slug: 'asc' | 'desc' }

      - `sort_order?: number | null`

      - `team_id?: string | null`

      - `updated_at?: string | null`

      - `user_id?: string | null`

### Example

```typescript
import Micro from '@micro-so/sdk';

const client = new Micro({
  teamID: 'My Team ID',
  apiKey: process.env['MICRO_API_KEY'], // This is the default and can be omitted
});

const view = await client.views.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
  viewObjectType: 'action',
});

console.log(view);
```

#### Response

```json
{
  "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"
}
```