# Records

## List records selected by a view (filters and sorts applied; pinned record_order overlaid first)

**get** `/v2/prism/{teamId}/{viewObjectType}/views/{viewId}/records`

List records selected by a view (filters and sorts applied; pinned record_order overlaid first)

### Path Parameters

- `teamId: optional string`

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

  - `"action"`

  - `"deal"`

  - `"document"`

  - `"event"`

  - `"identity"`

  - `"organization"`

- `viewId: string`

### Query Parameters

- `cursor: optional string`

  Opaque cursor from a previous response's `next_cursor`. Pass it back unchanged to fetch the next page. When set, `page` and `limit` are derived from the cursor.

- `limit: optional number`

- `page: optional number`

  Page number (1-based). Prefer `cursor`.

### Returns

- `data: array of map[unknown]`

- `has_more: boolean`

  True if more records exist beyond this page.

- `next_cursor: optional string`

  Opaque cursor for the next page; null when `has_more` is false.

### Example

```http
curl https://developers.micro.so/v2/prism/$TEAM_ID/$VIEW_OBJECT_TYPE/views/$VIEW_ID/records \
    -H "x-api-key: $MICRO_API_KEY"
```

#### Response

```json
{
  "data": [
    {
      "foo": "bar"
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}
```

## Bulk reorder pinned records

**patch** `/v2/prism/{teamId}/{viewObjectType}/views/{viewId}/records`

Bulk reorder pinned records

### Path Parameters

- `teamId: optional string`

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

  - `"action"`

  - `"deal"`

  - `"document"`

  - `"event"`

  - `"identity"`

  - `"organization"`

- `viewId: string`

### Header Parameters

- `"Idempotency-Key": optional string`

### Body Parameters

- `object_ids: array of string`

### Example

```http
curl https://developers.micro.so/v2/prism/$TEAM_ID/$VIEW_OBJECT_TYPE/views/$VIEW_ID/records \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "x-api-key: $MICRO_API_KEY" \
    -d '{
          "object_ids": [
            "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          ]
        }'
```

## Pin a record to the view (append to record_order)

**post** `/v2/prism/{teamId}/{viewObjectType}/views/{viewId}/records/{objectId}`

Pin a record to the view (append to record_order)

### Path Parameters

- `teamId: optional string`

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

  - `"action"`

  - `"deal"`

  - `"document"`

  - `"event"`

  - `"identity"`

  - `"organization"`

- `viewId: string`

- `objectId: string`

### Header Parameters

- `"Idempotency-Key": optional string`

### Example

```http
curl https://developers.micro.so/v2/prism/$TEAM_ID/$VIEW_OBJECT_TYPE/views/$VIEW_ID/records/$OBJECT_ID \
    -X POST \
    -H "x-api-key: $MICRO_API_KEY"
```

## Unpin a record from the view

**delete** `/v2/prism/{teamId}/{viewObjectType}/views/{viewId}/records/{objectId}`

Unpin a record from the view

### Path Parameters

- `teamId: optional string`

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

  - `"action"`

  - `"deal"`

  - `"document"`

  - `"event"`

  - `"identity"`

  - `"organization"`

- `viewId: string`

- `objectId: string`

### Example

```http
curl https://developers.micro.so/v2/prism/$TEAM_ID/$VIEW_OBJECT_TYPE/views/$VIEW_ID/records/$OBJECT_ID \
    -X DELETE \
    -H "x-api-key: $MICRO_API_KEY"
```

## Domain Types

### Record List Response

- `RecordListResponse object { data, has_more, next_cursor }`

  - `data: array of map[unknown]`

  - `has_more: boolean`

    True if more records exist beyond this page.

  - `next_cursor: optional string`

    Opaque cursor for the next page; null when `has_more` is false.