# RESOURCE /v2/scrumboard/lists

<div class="api-docs" id="bkmrk-">  <div class="endpoint-section">  
</div></div>## Deep Hydration Logic Flow

منطق غنی‌سازی عمیق (Deep Hydration) که در اکثر متدها (Index, Store, Show, Update) اجرا می‌شود تا ساختار درختی کامل بورد را بسازد:

<div class="api-docs" id="bkmrk-start-request-%28index"><div class="endpoint-section"><div class="flowchart"><div class="flow-item">Start Request (Index/Store/Show)</div><div class="flow-arrow">↓</div><div class="flow-item-process">Fetch List(s) Record from DB</div><div class="flow-arrow">↓</div><div class="flow-item-process" style="background-color: #e3f2fd;">**Loop: For Each List**  
Fetch `scrumboard_cards`</div><div class="flow-arrow">↓</div><div class="flow-item-decision">Has Cards?</div><div style="position: relative;"><div class="flow-arrow-label-right" style="top: -20px; right: -50px;">No</div><div class="flow-item-process" style="float: right; margin-right: -160px; width: 140px; font-size: 11px; background: #f5f5f5; color: #999;">Skip Hydration  
Return Empty Cards []</div></div><div class="flow-arrow">↓ (Yes)</div><div class="flow-item-process" style="background-color: #fff3e0;">**Start Nested Loop: For Each Card**</div><div style="display: flex; justify-content: space-between; margin-top: 20px; gap: 10px;"><div style="width: 48%;"><div class="flow-item-process" style="font-size: 11px;">**1. Decode Members**  
Fetch Operators (Avatar, Name)</div><div class="flow-arrow">↓</div><div class="flow-item-process" style="font-size: 11px;">**2. Decode Labels**  
Fetch Label Details</div><div class="flow-arrow">↓</div><div class="flow-item-process" style="font-size: 11px;">**3. Sprints**  
Filter Sprints by JSON</div></div><div style="width: 48%;"><div class="flow-item-process" style="font-size: 11px;">**4. Comments**  
Fetch &amp; Hydrate Operator</div><div class="flow-arrow">↓</div><div class="flow-item-process" style="font-size: 11px;">**5. Checklists**  
Decode Items &amp; Hydrate Operator</div><div class="flow-arrow">↓</div><div class="flow-item-process" style="font-size: 11px;">**6. Media**  
Fetch Attachments</div></div></div><div class="flow-arrow">↓</div><div class="flow-item-process">Merge All Data into Card Object</div><div class="flow-arrow">↓</div><div class="flow-item-process">Add Card to List Object</div><div class="flow-arrow">↓</div><div class="flow-item-success">Return Nested JSON Response</div></div></div>  
---

  </div># Get Board Lists

دریافت تمام لیست‌های (ستون‌های) مربوط به یک بورد خاص به همراه تمام کارت‌ها و جزئیات آن‌ها.

<div class="api-docs" id="bkmrk-url%3A-%2Fv2%2Fscrumboard%2F"><div class="endpoint-info"><div>**URL:** `/v2/scrumboard/lists`</div><div>**Method:** <span class="method-get">GET</span></div><div>**Controller:** ListController@index</div></div></div>### Parameters

<div class="api-docs" id="bkmrk-parameter-type-locat"><table class="schema-table" dir="rtl"><thead><tr><th>Parameter</th><th>Type</th><th>Location</th><th>Description</th></tr></thead><tbody><tr><td dir="ltr">board\_id</td><td>Integer</td><td>Query</td><td>(الزامی) شناسه بوردی که لیست‌ها متعلق به آن هستند.</td></tr><tr><td dir="ltr">status</td><td>Integer</td><td>Query</td><td>(اختیاری) فیلتر بر اساس وضعیت لیست.</td></tr></tbody></table>

</div>### Response Structure

```json
{
    "items": [
        {
            "id": 1,
            "board_id": 10,
            "title": "To Do",
            "priority": 2,
            "cards": [
                {
                    "id": 101,
                    "title": "Task 1",
                    "members": [ { "id": 1, "first_name": "Ali", ... } ],
                    "labels": [ { "id": 5, "title": "Bug", "color": "red" } ],
                    "comments": [ ... ],
                    "checklists": [ ... ],
                    "attachments": [ ... ],
                    "sprints": [ ... ]
                }
            ]
        }
    ],
    "meta": { "timestamp": 1733754000 }
}
```

<div class="api-docs" id="bkmrk--1">---

  </div># Create List

ایجاد یک لیست (ستون) جدید در بورد. بلافاصله پس از ایجاد، رکورد بازیابی شده و فرآیند Hydration روی آن اجرا می‌شود.

<div class="api-docs" id="bkmrk-url%3A-%2Fv2%2Fscrumboard%2F-1"><div class="endpoint-info"><div>**URL:** `/v2/scrumboard/lists`</div><div>**Method:** <span class="method-post">POST</span></div><div>**Controller:** ListController@store</div></div></div>### Parameters

<div class="api-docs" id="bkmrk-parameter-type-descr"><table class="schema-table" dir="rtl"><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td dir="ltr">board\_id</td><td>Integer</td><td>شناسه بورد والد.</td></tr><tr><td dir="ltr">title</td><td>String</td><td>عنوان لیست.</td></tr><tr><td dir="ltr">color</td><td>String</td><td>رنگ لیست (کد HEX).</td></tr></tbody></table>

</div>### Success Response

```json
{
    "payload": {
        "id": 5,
        "title": "New Column",
        "cards": [],
        "created_at": "..."
    },
    "meta": { "timestamp": 1733754000 }
}
```

<div class="api-docs" id="bkmrk--2">---

  </div># Show List

دریافت اطلاعات یک لیست خاص با شناسه ID. این متد نیز تمامی کارت‌ها و وابستگی‌های آن‌ها را بارگذاری می‌کند.

<div class="api-docs" id="bkmrk-url%3A-%2Fv2%2Fscrumboard%2F-2"><div class="endpoint-info"><div>**URL:** `/v2/scrumboard/lists/{id}`</div><div>**Method:** <span class="method-get">GET</span></div><div>**Controller:** ListController@show</div></div></div>### Path Parameters

<div class="api-docs" id="bkmrk-parameter-type-descr-1"><table class="schema-table" dir="rtl"><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>id</td><td>Integer</td><td>شناسه لیست (List ID).</td></tr></tbody></table>

---

  </div># Update List

ویرایش اطلاعات یک لیست.

<div class="api-docs" id="bkmrk-url%3A-%2Fv2%2Fscrumboard%2F-3"><div class="endpoint-info"><div>**URL:** `/v2/scrumboard/lists/{id}`</div><div>**Method:** <span class="method-put">PUT</span> / <span class="method-patch">PATCH</span></div><div>**Controller:** ListController@update</div></div></div>### Parameters

<div class="api-docs" id="bkmrk-parameter-type-descr-2"><table class="schema-table" dir="rtl"><thead><tr><th>Parameter</th><th>Type</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td dir="ltr">board\_id</td><td>Integer</td><td>شناسه بورد.</td><td>-</td></tr><tr><td dir="ltr">title</td><td>String</td><td>عنوان لیست.</td><td>-</td></tr><tr><td dir="ltr">color</td><td>String</td><td>رنگ لیست.</td><td>-</td></tr><tr><td dir="ltr">priority</td><td>Integer</td><td>اولویت نمایش (Sort Order).</td><td>0</td></tr><tr><td dir="ltr">status</td><td>Integer</td><td>وضعیت لیست.</td><td>1</td></tr></tbody></table>

</div>### Success Response

```json
{
    "payload": {
        "id": 5,
        "title": "Edited Title",
        "priority": 10,
        "cards": [ ... ]
    },
    "meta": { "timestamp": 1733754000 }
}
```

<div class="api-docs" id="bkmrk--3">---

  </div># Delete List

حذف کامل یک لیست از دیتابیس.

<div class="api-docs" id="bkmrk-url%3A-%2Fv2%2Fscrumboard%2F-4"><div class="endpoint-info"><div>**URL:** `/v2/scrumboard/lists/{id}`</div><div>**Method:** <span class="method-delete">DELETE</span></div><div>**Controller:** ListController@destroy</div></div></div>### Success Response

```json
{
    "payload": 1, // تعداد ردیف‌های حذف شده
    "meta": {
        "timestamp": 1733754000
    }
}
```