List Visitor Lists

Retrieve a paginated list of visitor lists (segments)

GET /api/v1/lists

cURL

curl -X GET "https://api.orwel.io/api/v1/lists?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "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
  }
}

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

Show 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

cURL

curl -X GET "https://api.orwel.io/api/v1/lists?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "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
  }
}