API Reference

Views

Records

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

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

client.Views.Records.List(ctx, viewObjectType, viewID, params) (*ViewRecordListResponse, error)

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

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

ParametersExpand Collapse

viewObjectType ViewRecordListParamsViewObjectType

One of the following:

const ViewRecordListParamsViewObjectTypeAction ViewRecordListParamsViewObjectType = "action"

const ViewRecordListParamsViewObjectTypeDeal ViewRecordListParamsViewObjectType = "deal"

const ViewRecordListParamsViewObjectTypeDocument ViewRecordListParamsViewObjectType = "document"

const ViewRecordListParamsViewObjectTypeEvent ViewRecordListParamsViewObjectType = "event"

const ViewRecordListParamsViewObjectTypeIdentity ViewRecordListParamsViewObjectType = "identity"

const ViewRecordListParamsViewObjectTypeOrganization ViewRecordListParamsViewObjectType = "organization"

viewID string

formatuuid

params ViewRecordListParams

TeamID param.Field[string]Optional

Path param

formatuuid

Cursor param.Field[string]Optional

Query param: 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 param.Field[int64]Optional

Query param

minimum0

maximum50

Page param.Field[int64]Optional

Query param: Page number (1-based). Prefer cursor.

minimum1

ReturnsExpand Collapse

type ViewRecordListResponse struct{…}

Data []map[string, unknown]

HasMore bool

True if more records exist beyond this page.

NextCursor stringOptional

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

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

Go

HTTP

TypeScript

Python

Go

package main

import (
  "context"
  "fmt"

  "github.com/micro-so/micro-sdk-go"
  "github.com/micro-so/micro-sdk-go/option"
)

func main() {
  client := micro.NewClient(
    option.WithAPIKey("My API Key"),
    option.WithTeamID("My Team ID"),
  )
  records, err := client.Views.Records.List(
    context.TODO(),
    micro.ViewRecordListParamsViewObjectTypeAction,
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    micro.ViewRecordListParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", records.Data)
}

200 example

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

Returns Examples

200 example

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