> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getarca.app/llms.txt
> Use this file to discover all available pages before exploring further.

# List lists

> Returns all lists in a workspace, ordered by position then name.

<Info>
  Requires the `lists:read` scope. You must be a member of the workspace.
  Access-restricted members only receive lists within their permitted folders or
  explicitly granted lists.
</Info>

## Path parameters

<ParamField path="id" type="string" required>
  The numeric workspace ID.
</ParamField>

## Response

Returns an array of list objects.

<ResponseField name="id" type="number" required>
  List identifier.
</ResponseField>

<ResponseField name="workspace_id" type="number" required>
  ID of the workspace this list belongs to.
</ResponseField>

<ResponseField name="folder_id" type="number | null">
  ID of the parent folder. `null` if the list is not inside a folder.
</ResponseField>

<ResponseField name="name" type="string" required>
  List name.
</ResponseField>

<ResponseField name="icon" type="string | null">
  Icon identifier slug (e.g., `"folder-1"`, `"chart"`, `"code"`). `null` if not
  set.
</ResponseField>

<ResponseField name="color" type="string | null">
  List color.
</ResponseField>

<ResponseField name="position" type="number" required>
  Numeric sort position. Lists are ordered by this value ascending.
</ResponseField>

<ResponseField name="created_at" type="string" required>
  UTC ISO-8601 creation timestamp.
</ResponseField>

<ResponseExample>
  ```json 200 theme={null}
  [
    {
      "id": 20,
      "workspace_id": 3,
      "folder_id": 10,
      "name": "Backend",
      "icon": "code",
      "color": "blue",
      "position": 1,
      "created_at": "2026-01-15T08:00:00.000Z"
    },
    {
      "id": 21,
      "workspace_id": 3,
      "folder_id": 10,
      "name": "Frontend",
      "icon": "chart",
      "color": "green",
      "position": 2,
      "created_at": "2026-01-15T08:05:00.000Z"
    }
  ]
  ```

  ```json 401 theme={null}
  {
    "error": "Invalid API key"
  }
  ```

  ```json 403 theme={null}
  {
    "error": "Scope 'lists:read' is required for this endpoint"
  }
  ```

  ```json 404 theme={null}
  {
    "error": "Workspace not found"
  }
  ```
</ResponseExample>
