API Reference

Prism

Lists

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get a list by id

client.Prism.Lists.Get(ctx, listID, query) (*List, error)

GET/v2/prism/{teamId}/lists/{listId}

Get a list by id

ParametersExpand Collapse

listID string

formatuuid

query PrismListGetParams

TeamID param.Field[string]Optional

formatuuid

ReturnsExpand Collapse

type List struct{…}

ID string

formatuuid

Name string

minLength1

ObjectType ListObjectType

Prism object type this list holds.

One of the following:

const ListObjectTypeOrganization ListObjectType = "organization"

const ListObjectTypeIdentity ListObjectType = "identity"

const ListObjectTypeAction ListObjectType = "action"

const ListObjectTypeDocument ListObjectType = "document"

const ListObjectTypeDeal ListObjectType = "deal"

TeamID string

formatuuid

CreatedAt TimeOptional

formatdate-time

Description stringOptional

Icon stringOptional

Emoji or icon key for the list.

Type stringOptional

Internal template type (e.g. dealFlow, hiring). Derived from template_id on create.

Views []ListViewOptional

ID string

formatuuid

Name stringOptional

Get a list by id

Go

HTTP

TypeScript

Python

Go

CLI Tool

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"),
  )
  list, err := client.Prism.Lists.Get(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    micro.PrismListGetParams{

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

200 example

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "name": "x",
  "object_type": "organization",
  "team_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "icon": "icon",
  "type": "type",
  "views": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "name": "name"
    }
  ]
}

Returns Examples

200 example

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "name": "x",
  "object_type": "organization",
  "team_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "icon": "icon",
  "type": "type",
  "views": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "name": "name"
    }
  ]
}