Skip to content
Go to Micro

Create a list (app/CRM)

prism.lists.create(ListCreateParams**kwargs) -> List
POST/v2/prism/{teamId}/lists

Creates a list from a template. Seeds properties, pipeline stages (when applicable), and default views — identical to the session-auth /default_app/create path. API-key callers are fully supported; type is derived from template_id and must not be supplied.

ParametersExpand Collapse
team_id: Optional[str]
formatuuid
template_id: Literal["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: Optional[str]

Emoji or icon override.

minLength1
maxLength32
name: Optional[str]
minLength1
maxLength255
object_type: Optional[Literal["organization", "identity", "action", 2 more]]

Required only when template_id is custom.

One of the following:
"organization"
"identity"
"action"
"document"
"deal"
idempotency_key: Optional[str]
minLength1
maxLength255
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]

Create a list (app/CRM)

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.create(
    template_id="sales_deals",
)
print(list.id)
{
  "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
{
  "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"
    }
  ]
}