Create List

POST /2/lists

Creates a new List.

Body

  • name string Required
  • description string
  • private boolean

Responses

  • default

    The request has failed.

    Hide response attributes Show response attributes object
    • code integer(int32) Required
    • message string Required
  • 200

    The request was successful

    Hide response attributes Show response attributes object
    • data object

      A Twitter List is a curated group of accounts.

      Hide data attributes Show data attributes object
      • id string Required

        The unique identifier of this List.

        Format should match the following pattern: ^[0-9]{1,19}$.

      • name string Required

        The name of this List.

      • created_at string(date-time)
      • description string
      • follower_count integer
      • member_count integer
      • owner_id string

        Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

        Format should match the following pattern: ^[0-9]{1,19}$.

      • private boolean
    • errors array[object]

      An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).

      At least 1 element.

      Hide errors attributes Show errors attributes array[object]
      • type string Required
      • title string Required
      • detail string
      • status integer
POST /2/lists
curl \
 -X POST https://api.twitter.com/2/lists \
 -H "Authorization: Oauth $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"name":"string","description":"string","private":true}'
Request example
{
  "name": "string",
  "description": "string",
  "private": true
}
Request examples
{
  "name": "string",
  "description": "string",
  "private": true
}
Response examples (default)
{
  "code": 42,
  "message": "string"
}
Response examples (default)
{
  "code": 42,
  "message": "string"
}
Response examples (200)
{
  "data": {
    "id": "1146654567674912769",
    "name": "string",
    "created_at": "2023-05-04T09:42:00+00:00",
    "description": "string",
    "follower_count": 42,
    "member_count": 42,
    "owner_id": "2244994945",
    "private": true
  },
  "errors": [
    {
      "type": "string",
      "title": "string",
      "detail": "string",
      "status": 42
    }
  ]
}
Response examples (200)
{
  "data": {
    "id": "1146654567674912769",
    "name": "string",
    "created_at": "2025-05-04T09:42:00Z",
    "description": "string",
    "follower_count": 42,
    "member_count": 42,
    "owner_id": "2244994945",
    "private": true
  },
  "errors": [
    {
      "type": "string",
      "title": "string",
      "detail": "string",
      "status": 42
    }
  ]
}