# Lists

## 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.

### Parameters

- `team_id: Optional[str]`

- `template_id: Literal["sales_deals", "recruiting", "partnerships", 11 more]`

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

  - `"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.

- `name: Optional[str]`

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

  Required only when template_id is `custom`.

  - `"organization"`

  - `"identity"`

  - `"action"`

  - `"document"`

  - `"deal"`

- `idempotency_key: Optional[str]`

### Returns

- `List`

  - `id: str`

  - `name: str`

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

    Prism object type this list holds.

    - `"organization"`

    - `"identity"`

    - `"action"`

    - `"document"`

    - `"deal"`

  - `team_id: str`

  - `created_at: Optional[datetime]`

  - `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`

    - `name: Optional[str]`

### Example

```python
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)
```

#### Response

```json
{
  "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"
    }
  ]
}
```

## List apps/CRMs in a workspace

`prism.lists.list(ListListParams**kwargs)  -> ListListResponse`

**get** `/v2/prism/{teamId}/lists`

Returns non-core lists the caller can access in the workspace. Core system apps (Messages, All Inbox) are excluded.

### Parameters

- `team_id: Optional[str]`

### Returns

- `class ListListResponse: …`

  - `data: List[List]`

    - `id: str`

    - `name: str`

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

      Prism object type this list holds.

      - `"organization"`

      - `"identity"`

      - `"action"`

      - `"document"`

      - `"deal"`

    - `team_id: str`

    - `created_at: Optional[datetime]`

    - `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`

      - `name: Optional[str]`

### Example

```python
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
)
lists = client.prism.lists.list()
print(lists.data)
```

#### Response

```json
{
  "data": [
    {
      "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"
        }
      ]
    }
  ]
}
```

## Get a list by id

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

**get** `/v2/prism/{teamId}/lists/{listId}`

Get a list by id

### Parameters

- `team_id: Optional[str]`

- `list_id: str`

### Returns

- `List`

  - `id: str`

  - `name: str`

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

    Prism object type this list holds.

    - `"organization"`

    - `"identity"`

    - `"action"`

    - `"document"`

    - `"deal"`

  - `team_id: str`

  - `created_at: Optional[datetime]`

  - `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`

    - `name: Optional[str]`

### Example

```python
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)
```

#### Response

```json
{
  "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"
    }
  ]
}
```

## Domain Types

### List

- `class List: …`

  - `id: str`

  - `name: str`

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

    Prism object type this list holds.

    - `"organization"`

    - `"identity"`

    - `"action"`

    - `"document"`

    - `"deal"`

  - `team_id: str`

  - `created_at: Optional[datetime]`

  - `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`

    - `name: Optional[str]`

### List Create

- `class ListCreate: …`

  - `template_id: Literal["sales_deals", "recruiting", "partnerships", 11 more]`

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

    - `"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.

  - `name: Optional[str]`

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

    Required only when template_id is `custom`.

    - `"organization"`

    - `"identity"`

    - `"action"`

    - `"document"`

    - `"deal"`

### List List Response

- `class ListListResponse: …`

  - `data: List[List]`

    - `id: str`

    - `name: str`

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

      Prism object type this list holds.

      - `"organization"`

      - `"identity"`

      - `"action"`

      - `"document"`

      - `"deal"`

    - `team_id: str`

    - `created_at: Optional[datetime]`

    - `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`

      - `name: Optional[str]`