> ## Documentation Index
> Fetch the complete documentation index at: https://docs.connie.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a list

> Creates a list on an existing object (`entity_table_id`), or a standalone list with its own new object (`workspace_id` only). With `is_folder: true` it creates a folder instead, which needs `workspace_id`. A static list holds the records you add; a smart list shows the object's records that match its `filters`.




## OpenAPI

````yaml /openapi/records.yaml post /lists
openapi: 3.1.0
info:
  title: Connie Records API
  version: 1.0.0
  description: >
    Endpoints the Connie web app uses for records. They authenticate with your
    signed-in browser session — see
    https://docs.connie.ai/api-reference/authentication. These are the app's own
    endpoints and can change when the app changes.
servers:
  - url: https://connie.ai/api
security:
  - sessionCookie: []
tags:
  - name: Lists
    description: Lists of records on an object, and the records in them.
  - name: People
    description: Find, match and create records on the People object.
  - name: Companies
    description: Find and create records on the Companies object.
  - name: Notes
    description: Notes on a person.
  - name: Tasks
    description: Tasks linked to a person or a company, and their comments.
paths:
  /lists:
    post:
      tags:
        - Lists
      summary: Create a list
      description: >
        Creates a list on an existing object (`entity_table_id`), or a
        standalone list with its own new object (`workspace_id` only). With
        `is_folder: true` it creates a folder instead, which needs
        `workspace_id`. A static list holds the records you add; a smart list
        shows the object's records that match its `filters`.
      operationId: createList
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 200
                entity_table_id:
                  type: string
                  format: uuid
                  description: The object to build the list on. You need edit access to it.
                workspace_id:
                  type: string
                  format: uuid
                  description: >-
                    Required when `entity_table_id` is omitted or for a folder.
                    Note the snake-case name.
                list_type:
                  type: string
                  enum:
                    - static
                    - smart
                  default: static
                filters:
                  description: >-
                    Smart-list conditions, in the same shape the grid's filter
                    builder saves.
                description:
                  type: string
                icon:
                  type: string
                color:
                  type: string
                parent_id:
                  type:
                    - string
                    - 'null'
                  format: uuid
                  description: Folder to put the list in.
                is_folder:
                  type: boolean
                  description: Create a folder rather than a list.
      responses:
        '201':
          description: The new list or folder.
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    $ref: '#/components/schemas/List'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    List:
      type: object
      properties:
        id:
          type: string
          format: uuid
        workspace_id:
          type: string
          format: uuid
        entity_table_id:
          type:
            - string
            - 'null'
          format: uuid
          description: The object the list is built on. Null for a folder.
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        icon:
          type:
            - string
            - 'null'
        color:
          type:
            - string
            - 'null'
        list_type:
          type: string
          enum:
            - static
            - smart
        filters:
          description: Smart-list conditions.
        is_system:
          type: boolean
          description: True for the automatic "All records" list of an object.
        is_folder:
          type:
            - boolean
            - 'null'
        parent_id:
          type:
            - string
            - 'null'
          format: uuid
          description: Folder the list is in.
        access_mode:
          type: string
          enum:
            - everyone
            - specific_users
            - creator_only
        created_by:
          type:
            - string
            - 'null'
          format: uuid
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable message.
        code:
          type: string
          description: Machine-readable code, when there is one.
      required:
        - error
  responses:
    BadRequest:
      description: A required field is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: >-
        No valid session (`UNAUTHORIZED`), or the session has expired
        (`SESSION_EXPIRED`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: You aren't a member of the workspace or don't have access to this item.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    sessionCookie:
      type: apiKey
      in: header
      name: Cookie
      description: >-
        The full Cookie header copied from a signed-in connie.ai browser
        request. See the Authentication page.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.