Skip to content
API Reference
Views

Get view

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

GET/v2/prism/{teamId}/{objectType}/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}.

x-api-key<token>

Public API key generated from Micro settings. Sent as the x-api-key header and validated by AWS API Gateway in front of the service.

In: header

Path Parameters

teamId*string
Formatuuid
objectType*string

Value in

  • "comment"
  • "action"
  • "deal"
  • "engagement"
  • "document"
  • "event"
  • "identity"
  • "organization"
viewId*string
Formatuuid

Query Parameters

include?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.

cursor?string

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

page?integer
Deprecated

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

Range1 <= value
limit?integer

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

Range0 <= value <= 50

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://developers.micro.so/v2/prism/${MICRO_TEAM_ID}/comment/views/${VIEW_ID}" \  -H "x-api-key: $MICRO_API_KEY"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba",  "list_id": "430bbdbc-9d7f-4d06-a273-67ca4ba4ae4b",  "user_id": "string",  "name": "string",  "icon": "string",  "view_type": "string",  "combinator": "AND",  "sort_order": 0,  "column_layout": {},  "group_by": "string",  "group_sort": "string",  "group_hide_empty": true,  "group_hidden_option_ids": [],  "aggregation_type": "string",  "aggregation_prop_def_id": "f2e3c603-7b25-462c-b4a5-354ca65d9bdc",  "select": [    "string"  ],  "filter": [    {}  ],  "sort": [    {}  ],  "created_at": "string",  "updated_at": "string"}
micro.so