Get a board

200

The board.

Content type: application/json

Type: BoardEnvelope

• success boolean
• data Board
  Show Board properties

  • id string
    Example: brd_3f9a1c7e2b8d4a60
  • org_id string
  • name string
  • description string
  • status string
    One of: active closed
  • team_id string
    The team the board belongs to, or "" for the whole organization.
  • visibility Visibility
    One of: org team private
  • created_by string
    The user ID (or, for an organization key, the key's ID) that created the board.
  • created_at string (date-time)
  • voting_enabled boolean
  • comments_enabled boolean
  • sort_by_votes boolean
    Every column's cards are ordered highest vote first, for everyone.
  • share_mode ShareMode
    One of: disabled read_only participate
  • share_token string
    The credential the board's share link carries.
  • share_url string
    The board's share link; left out while sharing is disabled.
  • timer Timer
    Show Timer properties

    • state string
      A running timer whose end has passed stays running with remaining_ms 0 until it is stopped.
      One of: idle running paused
    • ends_at string (date-time)
      When a running countdown ends; left out otherwise.
    • remaining_ms integer (int64)
      Time left, in milliseconds.
    • server_time string (date-time)
      The server's clock when the timer was read.
  • columns array of Column
    Only when one board is read; left out when the board has none.
    Show Column properties

    • id string
      Example: col_1a2b3c4d5e6f7a80
    • board_id string
    • name string
    • emoji string
    • color string
    • position integer
    • sort_order integer
    • created_at string (date-time)
    • cards array of Card
      Only when a whole board is read.
      Show Card properties

      • id string
        Example: crd_8d0c4b6e1a9f2357
      • board_id string
      • column_id string
      • content string
      • created_at string (date-time)
      • reactions array of Reaction
        Only when a whole board is read; left out when there are none.
        Show Reaction properties

        • emoji string
        • count integer
        • reacted boolean
          Whether the caller reacted with this emoji.
      • comments array of Comment
        Only when a whole board is read; left out when there are none.
        Show Comment properties

        • id string
          Example: cmt_4e6a8c0b2d1f3957
        • card_id string
        • board_id string
        • content string
        • created_at string (date-time)
      • vote_score integer
        The net of agree (+1) and disagree (-1) votes.
      • my_vote integer
        The caller's own vote on the card.
        One of: -1 0 1
  • action_items array of ActionItem
    Only when one board is read; left out when the board has none.
    Show ActionItem properties

    • id string
      Example: act_5b2e8c1d9f4a7e30
    • board_id string
    • description string
    • assignee string
      A free-text owner name; "" when none.
    • assignee_user_id string | null
      The organization member who owns the item.
    • status string
      One of: open done
    • created_at string (date-time)
    • updated_at string (date-time)
      When the item last changed.
    • completed_at string (date-time) | null
      When the item was marked done; null while open, and for some items done before this was recorded.
    • due_at string (date-time) | null

401

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

Content type: application/json

Type: Error

• success boolean
  Sent by Retro itself; refusals before the request reaches Retro (401, 429) carry only error.
  Value: false
• error object required
  • code string required
    Example: NOT_FOUND
  • message string required
    Example: board not found
  • request_id string

403

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

Content type: application/json

Type: Error

• success boolean
  Sent by Retro itself; refusals before the request reaches Retro (401, 429) carry only error.
  Value: false
• error object required
  • code string required
    Example: NOT_FOUND
  • message string required
    Example: board not found
  • request_id string

404

The board does not exist, or the caller cannot see it (NOT_FOUND).

Content type: application/json

Type: Error

• success boolean
  Sent by Retro itself; refusals before the request reaches Retro (401, 429) carry only error.
  Value: false
• error object required
  • code string required
    Example: NOT_FOUND
  • message string required
    Example: board 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

• success boolean
  Sent by Retro itself; refusals before the request reaches Retro (401, 429) carry only error.
  Value: false
• error object required
  • code string required
    Example: NOT_FOUND
  • message string required
    Example: board not found
  • request_id string

500

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

Content type: application/json

Type: Error

• success boolean
  Sent by Retro itself; refusals before the request reaches Retro (401, 429) carry only error.
  Value: false
• error object required
  • code string required
    Example: NOT_FOUND
  • message string required
    Example: board not found
  • request_id string