Skip to content
Go to Micro

Lists

Create a list (app/CRM)
client.prism.lists.create(ListCreateParams { teamId, template_id, icon, 3 more } params, RequestOptionsoptions?): List { id, name, object_type, 6 more }
POST/v2/prism/{teamId}/lists
List apps/CRMs in a workspace
client.prism.lists.list(ListListParams { teamId } params?, RequestOptionsoptions?): ListListResponse { data }
GET/v2/prism/{teamId}/lists
Get a list by id
client.prism.lists.get(stringlistID, ListGetParams { teamId } params?, RequestOptionsoptions?): List { id, name, object_type, 6 more }
GET/v2/prism/{teamId}/lists/{listId}
ModelsExpand Collapse
List { id, name, object_type, 6 more }
id: string
formatuuid
name: string
minLength1
object_type: "organization" | "identity" | "action" | 2 more

Prism object type this list holds.

One of the following:
"organization"
"identity"
"action"
"document"
"deal"
team_id: string
formatuuid
created_at?: string | null
formatdate-time
description?: string | null
icon?: string | null

Emoji or icon key for the list.

type?: string | null

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

views?: Array<View>
id: string
formatuuid
name?: string | null
ListCreate { template_id, icon, name, object_type }
template_id: "sales_deals" | "recruiting" | "partnerships" | 11 more

Template to seed the list from. type is derived server-side from this template.

One of the following:
"sales_deals"
"recruiting"
"partnerships"
"fundraising"
"knowledge_base"
"issue_tracker"
"content_calendar"
"job_applications"
"project_tracker"
"feedback"
"portco_tracker"
"deal_flow"
"lp_fundraising"
"custom"
icon?: string

Emoji or icon override.

minLength1
maxLength32
name?: string
minLength1
maxLength255
object_type?: "organization" | "identity" | "action" | 2 more

Required only when template_id is custom.

One of the following:
"organization"
"identity"
"action"
"document"
"deal"
ListListResponse { data }
data: Array<List { id, name, object_type, 6 more } >
id: string
formatuuid
name: string
minLength1
object_type: "organization" | "identity" | "action" | 2 more

Prism object type this list holds.

One of the following:
"organization"
"identity"
"action"
"document"
"deal"
team_id: string
formatuuid
created_at?: string | null
formatdate-time
description?: string | null
icon?: string | null

Emoji or icon key for the list.

type?: string | null

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

views?: Array<View>
id: string
formatuuid
name?: string | null