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

prism.lists.get(strlist_id, ListGetParams**kwargs) -> List

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

Get a list by id

ParametersExpand Collapse

team_id: Optional[str]

formatuuid

list_id: str

formatuuid

ReturnsExpand Collapse

List

id: str

formatuuid

name: str

minLength1

object_type: Literal["organization", "identity", "action", 2 more]

Prism object type this list holds.

One of the following:

"organization"

"identity"

"action"

"document"

"deal"

team_id: str

formatuuid

created_at: Optional[datetime]

formatdate-time

description: Optional[str]

icon: Optional[str]

Emoji or icon key for the list.

type: Optional[str]

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

views: Optional[List[View]]

id: str

formatuuid

name: Optional[str]

Get a list by id

Python

HTTP

TypeScript

Python

Go

CLI Tool

import os
from micro_so import Micro

client = Micro(
    api_key=os.environ.get("MICRO_API_KEY"),  # This is the default and can be omitted
)
list = client.prism.lists.get(
    list_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(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"
    }
  ]
}