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

# List Visitor Lists

> Retrieve a paginated list of visitor lists (segments)

> [!NOTE]
>
> Requires an [API key](https://www.orwel.io/docs/authentication.md) (`orwel_sk_`) with the `visitors:read` scope.

## Query Parameters

**limit** `integer` (default: 50)

Maximum number of results to return (max: 100)

**offset** `integer` (default: 0)

Number of results to skip for pagination

## Response

**data** `array`

Array of visitor list objects

**List Object**

**id** `string`

Unique identifier for the list

**name** `string`

List name

**description** `string`

Description

**color** `string`

Color code

**created\_at** `string`

ISO 8601 timestamp of creation

**pagination** `object`

Pagination information

```bash cURL theme={null}
curl -X GET "https://api.orwel.io/api/v1/lists?limit=10" \
  -H "Authorization: Bearer orwel_sk_YOUR_KEY"
```

```json Response theme={null}
{
  "data": [
    {
      "id": "list-uuid",
      "name": "VIP Customers",
      "description": "High value customers",
      "color": "#FF0000",
      "created_at": "2025-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 5
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.