---
title: "Create a List"
method: POST
path: "/v2/lists"
tags: ["Lists"]
---

# Create a List

`POST /v2/lists`

Create a new List.

The List type determines the kind of entities (Companies, Persons, or Opportunities) that can be
added. The requester is recorded as the creator and the owner.

## Request body

- ListToBeCreated — Request body for creating a new List
  - `name` string, required — The name of the List
  - `type` 'company' | 'opportunity' | 'person', required — The entity type for the List
  - `isPublic` boolean — Whether the List is public. Public Lists are visible to all users in the organization. Creating a public List requires the "Share accessible Lists globally" permission.

## Response `201`

Created

- ListWithType — ListWithType model
  - `id` integer, required — The unique identifier for the list
  - `name` string, required — The name of the list
  - `creatorId` integer, required — The ID of the user that created this list
  - `ownerId` integer, required — The ID of the user that owns this list
  - `isPublic` boolean, required — Whether or not the list is public
  - `type` 'company' | 'opportunity' | 'person', required — The entity type for this list
  - `createdAt` string, date-time, required — The date and time the list was created

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `default` — Errors

---

[API](https://skmtc.net/affinity/apis/affinity-api-v2.md) · [All operations](https://skmtc.net/affinity/apis/affinity-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/affinity/affinity-api-v2/revisions/4c2891c31b7f/schema)