Skip to content
API Reference
Views

Create view

Create view using the reviewed public Micro API contract. Authentication uses the x-api-key header.

POST/v2/prism/{teamId}/{objectType}/views
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"

Header Parameters

Idempotency-Key?string

A unique key (UUID or any opaque string up to 255 chars) for an authenticated POST, PUT, or PATCH request. The server retains the initial claim for 24 hours and replays a completed non-5xx response only when the method, path, and request body all match. Reusing a non-expired key with a different method, path, or body returns 409 idempotency_key_mismatch; reusing it after expiry returns 409 idempotency_key_stale, so use a new key. Replays include the idempotent-replay: true response header.

Length1 <= length <= 255

Request Body

application/json

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.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://developers.micro.so/v2/prism/${MICRO_TEAM_ID}/comment/views" \  -H "x-api-key: $MICRO_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "view_type": "string"  }'
{  "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