Create a list

201

The list was created.

Content type: application/json

Type: object

• data object
  • list List
    Show List properties

    • id string
    • board_id string
    • name string
      Max length: 80
    • is_review_list boolean
    • is_done_list boolean
    • celebration Celebration
      One of: confetti hearts sparkles fireworks balloons bubbles petals emoji glow
    • created_by string
    • created_at string (date-time)
    • updated_at string (date-time)
    • cards array of Card
      The first page of the list's cards.
      Show Card properties

      • id string
        Example: crd_9f2e4d6c8b0a1e3f5d7c9b1a3e5f7d90
      • board_id string
      • list_id string
      • number integer
        The card's number on its board, from 1. With the board's card_prefix it is the card's reference.
      • title string
        Max length: 200
      • description string
        Max length: 20000
      • color string
        A hex colour, or "" for none.
      • due_at string (date-time)
        Absent when the card has no due date.
      • review Review
        Show Review properties

        • state string
          One of: pending approved
        • approved_by string
        • approved_at string (date-time)
      • completed_at string (date-time)
        When the card entered a done list. Absent while it is not in one.
      • created_by string
      • created_at string (date-time)
      • updated_at string (date-time)
      • version integer
        Goes up by one on every edit of the title or description.
      • assignee_ids array of string | null
        Who the card is on. Filled in when a board or list is read; null when one card is read on its own.
      • label_ids array of string | null
        The labels the card carries. Filled in when a board or list is read; null when one card is read on its own.
    • card_count integer
      How many cards the list holds, under the filters.
    • has_more boolean

400

The body is not JSON for this endpoint, or carries a field it does not know (INVALID_BODY), or a field breaks a rule (VALIDATION_ERROR; the message says which).

Content type: application/json

Type: Error

• error object required
  • code string required
    Example: NOT_FOUND
  • message string required
    Example: not found
  • request_id string

401

No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).

Content type: application/json

Type: Error

• error object required
  • code string required
    Example: NOT_FOUND
  • message string required
    Example: not found
  • request_id string

403

The key lacks the scope this endpoint needs (FORBIDDEN).

Content type: application/json

Type: Error

• error object required
  • code string required
    Example: NOT_FOUND
  • message string required
    Example: not found
  • request_id string

404

It does not exist, or it is on a board the caller cannot see (NOT_FOUND).

Content type: application/json

Type: Error

• error object required
  • code string required
    Example: NOT_FOUND
  • message string required
    Example: not found
  • request_id string

409

The neighbours named in placement are no longer next to each other (STALE_PLACEMENT). Read the board again and retry.

Content type: application/json

Type: Error

• error object required
  • code string required
    Example: NOT_FOUND
  • message string required
    Example: not found
  • request_id string

429

Too many requests (RATE_LIMITED). Wait for Retry-After seconds.

Headers

• Retry-After integer
  Seconds to wait before retrying.

Content type: application/json

Type: Error

• error object required
  • code string required
    Example: NOT_FOUND
  • message string required
    Example: not found
  • request_id string

500

Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.

Content type: application/json

Type: Error

• error object required
  • code string required
    Example: NOT_FOUND
  • message string required
    Example: not found
  • request_id string