Skip to content
Micro micro
Go to Micro
API Reference
Prism
Lists

Create a list (app/CRM)

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.

Path ParametersExpand Collapse
teamId: optional string
formatuuid
Header ParametersExpand Collapse
"Idempotency-Key": optional string
minLength1
maxLength255
Body ParametersJSONExpand Collapse
template_id: "sales_deals" or "recruiting" or "partnerships" or 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 string

Emoji or icon override.

minLength1
maxLength32
name: optional string
minLength1
maxLength255
object_type: optional "organization" or "identity" or "action" or 2 more

Required only when template_id is custom.

One of the following:
"organization"
"identity"
"action"
"document"
"deal"
ReturnsExpand Collapse
List object { id, name, object_type, 6 more }
id: string
formatuuid
name: string
minLength1
object_type: "organization" or "identity" or "action" or 2 more

Prism object type this list holds.

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

Emoji or icon key for the list.

type: optional string

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

views: optional array of object { id, name }
id: string
formatuuid
name: optional string

Create a list (app/CRM)

curl https://developers.micro.so/v2/prism/$TEAM_ID/lists \
    -H 'Content-Type: application/json' \
    -H "x-api-key: $MICRO_API_KEY" \
    -d '{
          "template_id": "sales_deals"
        }'
{
  "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"
    }
  ]
}